Files
awx-operator/docs
Elijah DeLee 6a2b42cdde allow configuration of uwsgi timeout
This is important when you have proxies in front of the service
that may have stricter timeouts, as you need at least as strict a
timeout at uwsgi to get meaningful traceback and see source of problem.
2025-02-19 14:38:54 -05:00
..

Building the Ansible AWX Operator Docs

To build the AWX Operator docs locally:

  1. Clone the AWX operator repository.
  2. Preferrably, create a virtual environment for installing the dependencies.
    a. python3 -m venv venv
    b. source venv/bin/activate
  3. From the root directory:
    a. pip install -r docs/requirements.txt
    b. mkdocs build
  4. 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.