Skip to content

key4hep/key4hep-doc

This branch is up to date with main.

Folders and files

NameName
Last commit message
Last commit date
Jan 6, 2025
Jan 16, 2025
Dec 17, 2024
Feb 13, 2020
Jan 16, 2025
Jan 6, 2025
Dec 21, 2023
Jan 6, 2025

Repository files navigation

Key4hep documentation

docs

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