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 index.

Getting started

The repository uses Git LFS to host large files. To not download all large files at the HEAD commit, we recommend --skip-smudge and letting adoc serve to fetch them as you navigate the live server and touches files:

sudo apt install git-lfs -y
GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/analogdevicesinc/documentation \
    --origin public \
    --depth 10 \
    -- documentation
cd documentation
git lfs install --local --force --skip-smudge

Install the documentation tools.

python3 -m venv ./venv
source ./venv/scripts/activate
python3 -m ensurepip
pip install pip --upgrade
(cd docs ; pip install -r requirements.txt --upgrade)

Launch the live server.

adoc serve

Or build the documentation with Sphinx.

(cd docs ; make html)

The generated documentation will be available at docs/_build/html.

VSCode support

Esbonio is an extensively developed Language Server Protocol and Visual Studio Code extension for sphinx. Setup the virtual environment first before opening the text editor, to avoid triggering fallback behaviours.

The live server cli is able to generate Estobio pyproject.toml entry with (including Sparse builds):

adoc serve --esbonio --sparse docs/learning | tee pyproject.toml

Assuming you followed the --skip-smudge instructions, you can use Git LFS On-Demand to auto fetch the artifacts included in open files or open. Get from Visual Studio Marketplace or Open VSX Registry

For word wrapping at the column 80, you can use Rewrap. Get from Visual Studio Marketplace or Open VSX Registry