https://github.com/analogdevicesinc/documentation
Repository to host system level documentation, it leverages Git LFS to ensure long term sustainability
https://github.com/analogdevicesinc/documentation
documentation reference-designs user-guides
Last synced: 7 months ago
JSON representation
Repository to host system level documentation, it leverages Git LFS to ensure long term sustainability
- Host: GitHub
- URL: https://github.com/analogdevicesinc/documentation
- Owner: analogdevicesinc
- Created: 2024-01-31T10:56:49.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-04T15:21:05.000Z (8 months ago)
- Last Synced: 2025-11-04T17:17:26.879Z (8 months ago)
- Topics: documentation, reference-designs, user-guides
- Homepage: https://analogdevicesinc.github.io/documentation/
- Size: 203 MB
- Stars: 2
- Watchers: 22
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing/creating_new_pages.rst
Awesome Lists containing this project
README
# System Level Documentation
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.
See the deployed docs output at the [System Level Documentation](https://analogdevicesinc.github.io/documentation/) index.
## Build the documentation
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`.
## Build all documentations
It's possible to build all ADI's documentation at once in parallel.
To generate it, considering Doctools is installed, do:
```
adoc aggregate -d docs_output
```
See [Doctools](https://github.com/analogdevicesinc/doctools) for more information.