mirror of
https://github.com/ansible/awx-operator.git
synced 2026-05-07 13:52:58 +00:00
Format Markdown list properly in upgrading.md (#1825)
Ensures the list is properly rendered in readthedocs website. Improves the documentation to build and serve the docs locally. Co-authored-by: Florian Sey <florian.sey@neofacto.com>
This commit is contained in:
@@ -2,9 +2,15 @@
|
||||
|
||||
To build the AWX Operator docs locally:
|
||||
|
||||
1. Clone the AWX operator repository.
|
||||
2. From the root directory:
|
||||
a. pip install --user -r docs/requirements.txt
|
||||
b. mkdocs build
|
||||
1. Clone the AWX operator repository.
|
||||
1. Preferrably, create a virtual environment for installing the dependencies.
|
||||
a. `python3 -m venv venv`
|
||||
b. `source venv/bin/activate`
|
||||
1. From the root directory:
|
||||
a. `pip install -r docs/requirements.txt`
|
||||
b. `mkdocs build`
|
||||
1. 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. To view the docs in your browser, navigate there in your file explorer and double-click on the `index.html` file. This should open the docs site in your browser.
|
||||
This will create a new directory called `site/` in the root of your clone containing the index.html and static files.
|
||||
|
||||
Reference in New Issue
Block a user