mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-27 05:43:11 +00:00
e0a8a88243
* Add hacking/ directory to .gitignore as it is commonly used for dev scripts * Add postgres_extra_settings * Add postgres_configuration_secret checksum to DB statefulset * Docs for postgres_extra_settings, CI coverage, and examples --------- Co-authored-by: Christian M. Adams <chadams@redhat.com>
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.