From e275d0dfae03c23ab6f6ed876245a8bee04b8d49 Mon Sep 17 00:00:00 2001 From: Stephen L Arnold Date: Wed, 20 Sep 2023 16:07:18 -0700 Subject: [PATCH] Update developer page with tox method for building sphinx docs * changes are in 02_building_complianceascode.md Signed-off-by: Stephen L Arnold --- .../developer/02_building_complianceascode.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/manual/developer/02_building_complianceascode.md b/docs/manual/developer/02_building_complianceascode.md index 3f67af4ab7b..38fd48b3489 100644 --- a/docs/manual/developer/02_building_complianceascode.md +++ b/docs/manual/developer/02_building_complianceascode.md @@ -159,6 +159,26 @@ apt-get install ninja-build ### Sphinx packages (Developer Documentation) +Building docs can be done via tox file or manually. Note that tox creates a +virtual environment to handle all dependencies defined in the docs requirements +file. + +#### Using the tox file + +```bash +# Fedora/RHEL +yum install tox + +# Ubuntu/Debian +apt-get install tox +``` + +```bash +tox -e docs +``` + +#### Manual method + Install Sphinx packages if you want to generate HTML Documentation, from source directory run: ```bash @@ -173,6 +193,10 @@ apt-get install python3-sphinx pip install -r docs/requirements.txt ``` +```bash +make -C docs html +``` + ### Pandas (SRG Export HTML) Install `pandas` if you want to run `utils/create_srg_export.py`: