Files
awx-operator/docs
llussyandChristian Adams dd37ebd440
CI / molecule (--skip-tags=replicas) (push) Failing after 3m57s
CI / molecule (-t replicas) (push) Failing after 5m9s
CI / helm (push) Failing after 5m23s
CI / no-log (push) Successful in 14s
CI / nox-sessions (push) Failing after 3m7s
Update index.md (#1904)
* Update docs/installation/index.md

---------

Co-authored-by: Christian Adams <[email protected]>
2024-06-26 20:17:22 +00:00
..
2024-06-26 20:17:22 +00:00
2023-08-03 15:13:11 -04: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.