mirror of
https://github.com/ansible/awx-operator.git
synced 2026-03-31 07:43:12 +00:00
731bb3dd18
Bumps the dependencies group in /docs with 1 update: [mkdocs-ansible](https://github.com/ansible/mkdocs-ansible). Updates `mkdocs-ansible` from 24.3.1 to 24.12.0 - [Release notes](https://github.com/ansible/mkdocs-ansible/releases) - [Commits](https://github.com/ansible/mkdocs-ansible/compare/v24.3.1...v24.12.0) --- updated-dependencies: - dependency-name: mkdocs-ansible dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies ... Signed-off-by: dependabot[bot] <support@github.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.