The System Level Documentation is the top documentation for Hardware, Projects, and some Linux documentation; it also has the ability to aggregate every other documentation into a single monolithic output/website.
Ensure pip is newer than version 23.
pip install pip --upgrade
Install/upgrade the documentation tools.
(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
.
It's possible to build all ADI's documentation at once. To generate it, considering Doctools is installed, do:
adoc aggregate -d docs_output
See Doctools for more information.