Skip to content

Commit

Permalink
Recommend upgrading and up aggregate on README.md
Browse files Browse the repository at this point in the history
Recommend upgrading the pip tools to ensure the user is running the
latest version of Doctools and the other tools.
Update aggregate info, removing monolithic mention in favor of symbolic
build.

Signed-off-by: Jorge Marques <[email protected]>
  • Loading branch information
gastmaier committed Sep 16, 2024
1 parent 3b73997 commit 67f6355
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ Ensure pip is newer than version 23.
```
pip install pip --upgrade
```
Install the documentation tools.
Install/upgrade the documentation tools.
```
(cd docs ; pip install -r requirements.txt)
(cd docs ; pip install -r requirements.txt --upgrade)
```
Build the documentation with Sphinx.
```
(cd docs ; make html)
```
The generated documentation will be available at `docs/_build/html`.

## Building the monolithic documentation
## Building the all documentations

The monolithic version aggregates all ADI's documentation into a single output/webpage.
It's possible to build all ADI's documentation at once.
To generate it, considering Doctools is installed, do:
```
adoc aggregate -d docs_output
Expand Down

0 comments on commit 67f6355

Please sign in to comment.