Files
awx-operator/docs
dependabot[bot] f27d7b28b8 Bump mkdocs-ansible from 24.3.0 to 24.3.1 in /docs in the dependencies group (#1856)
Bump mkdocs-ansible in /docs in the dependencies group

Bumps the dependencies group in /docs with 1 update: [mkdocs-ansible](https://github.com/ansible/mkdocs-ansible).


Updates `mkdocs-ansible` from 24.3.0 to 24.3.1
- [Release notes](https://github.com/ansible/mkdocs-ansible/releases)
- [Commits](https://github.com/ansible/mkdocs-ansible/compare/v24.3.0...v24.3.1)

---
updated-dependencies:
- dependency-name: mkdocs-ansible
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2024-05-20 15:05:09 -04: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.