Key4hep documentation

Key4hep central documentation

Getting dependencies

Install python dependencies:

pip install -r requirements.txt

Building locally

First fetch the documentation pages from other key4hep repositories:

.github/scripts/fetch_external_sources.sh 

If the sources already exist but you want to update them, use the --force option.

Then build the site locally:

sphinx-build -M html docs build

Check the links validity with:

sphinx-build -b linkcheck docs linkcheck