blob: a47463437eb95581e8b901cfb160b63eb85e2b52 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
Setting up your development environment
========================================
The AWX docs are developed using the Python toolchain. The content itself is authored in ReStructuredText (rst).
Prerequisites
---------------
.. contents::
:local:
Fork and clone the AWX repo
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
If you have not done so already, you'll need to fork the AWX repo on GitHub. For more on how to do this, see `Fork a Repo <https://help.github.com/articles/fork-a-repo/>`_.
Install python and setuptools
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Install the setuptools package on Linux using pip:
1. If not already installed, `download the latest version of Python3 <https://www.geeksforgeeks.org/how-to-download-and-install-python-latest-version-on-linux/>`_ on your machine.
2. Check if pip3 and python3 are correctly installed in your system using the following command:
::
python3 --version
pip3 --version
3. Upgrade pip3 to the latest version to prevent installation issues:
::
pip3 install --upgrade pip
4. Install Setuptools:
::
pip3 install setuptools
5. Verify whether the Setuptools has been properly installed:
::
python3 -c 'import setuptools'
If no errors are returned, then the package was installed properly.
6. Install the tox package so you can build the docs locally:
::
pip3 install tox
Run local build of the docs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
To build the docs on your local machine, use the tox utility. In your forked branch of your AWX repo, run:
::
tox -e docs
Access the AWX user interface
------------------------------
To access an instance of the AWX interface, refer to `Build and run the development environment <https://github.com/ansible/awx/blob/devel/CONTRIBUTING.md#setting-up-your-development-environment>`_ for detail. Once you have your environment setup, you can access the AWX UI by logging into it at `https://localhost:8043 <https://localhost:8043>`_, and access the API directly at `https://localhost:8043/api/ <https://localhost:8043/api/>`_.
|
