mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-26 21:33:14 +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>
606 B
606 B
Building the Ansible AWX Operator Docs
To build the AWX Operator docs locally:
- Clone the AWX operator repository.
- Preferrably, create a virtual environment for installing the dependencies.
a.python3 -m venv venv
b.source venv/bin/activate - From the root directory:
a.pip install -r docs/requirements.txt
b.mkdocs build - View the docs in your browser:
a.mkdocs serve
b. Open your browser and navigate tohttp://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.