3. 设置你的开发环境

AWX 文档是使用 Python 工具链开发的。内容本身是用 ReStructuredText (rst) 编写的。

3.1. 前提条件

3.1.1. Fork 并克隆 AWX 仓库

如果您尚未这样做,您需要在 GitHub 上 Fork AWX 仓库。有关如何执行此操作的更多信息,请参阅 Fork 一个仓库

3.1.2. 安装 python 和 setuptools

使用 pip 在 Linux 上安装 setuptools 包

  1. 如果尚未安装,请在您的机器上下载最新版本的 Python3

  2. 使用以下命令检查 pip3 和 python3 是否已正确安装在您的系统中

python3 --version
pip3 --version
  1. 将 pip3 升级到最新版本以防止安装问题

pip3 install --upgrade pip
  1. 安装 Setuptools

pip3 install setuptools
  1. 验证 Setuptools 是否已正确安装

python3 -c 'import setuptools'

如果没有返回错误,则表示该包已正确安装。

  1. 安装 tox 包,以便您可以在本地构建文档

pip3 install tox

3.1.3. 运行本地文档构建

要在您的本地机器上构建文档,请使用 tox 实用程序。在您 Fork 的 AWX 仓库分支中,运行

tox -e docs

3.2. 访问 AWX 用户界面

要访问 AWX 界面的实例,请参阅构建并运行开发环境以了解详细信息。设置好环境后,您可以通过在 https://127.0.0.1:8043 登录来访问 AWX UI,并通过 https://127.0.0.1:8043/api/ 直接访问 API。