Files
awx-operator/docs
shellclear 039157d070 Parameterization of the client_max_body_size directive in Nginx (#2014)
Enables users to customize client_max_body_size in Nginx conf to allow
for larger file uploads. This is useful in cases when users need to upload
large subscription manifest files.

---------

Co-authored-by: Seth Foster <fosterseth@users.noreply.github.com>
2025-02-24 12:50:08 -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.