mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-27 05:43:11 +00:00
f8bbe9f55a
Ensures the list is properly rendered in readthedocs website. Improves the documentation to build and serve the docs locally. Co-authored-by: Florian Sey <florian.sey@neofacto.com>
17 lines
606 B
Markdown
17 lines
606 B
Markdown
# Building the Ansible AWX Operator Docs
|
|
|
|
To build the AWX Operator docs locally:
|
|
|
|
1. Clone the AWX operator repository.
|
|
1. Preferrably, create a virtual environment for installing the dependencies.
|
|
a. `python3 -m venv venv`
|
|
b. `source venv/bin/activate`
|
|
1. From the root directory:
|
|
a. `pip install -r docs/requirements.txt`
|
|
b. `mkdocs build`
|
|
1. View the docs in your browser:
|
|
a. `mkdocs serve`
|
|
b. Open your browser and navigate to `http://127.0.0.1:8000/`
|
|
|
|
This will create a new directory called `site/` in the root of your clone containing the index.html and static files.
|