From 58e6d0ea5e894d8c323de720c4a103aabe96c916 Mon Sep 17 00:00:00 2001 From: "Travis F. Collins" Date: Wed, 24 Jan 2024 14:04:16 -0700 Subject: [PATCH] Update doc about generating doc Signed-off-by: Travis F. Collins --- CI/doc/README_doc.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/CI/doc/README_doc.md b/CI/doc/README_doc.md index 3b2a1207..b13505de 100644 --- a/CI/doc/README_doc.md +++ b/CI/doc/README_doc.md @@ -1,9 +1,17 @@ # Doc Creation -Doc is create by leveraging Sphinx as the documentation engine. To create the entire documentation set you must generate the dynamic pages which document the system object APIs and the reference designs. Then the output targets can be run. This is done by running the following command from the root of the toolbox: +Doc is create by leveraging Sphinx as the documentation engine. To create the entire documentation set you must generate the dynamic pages which document the system object APIs and the reference designs. Then the output targets can be run. Since doc gen requires sphinx and some plugins they need to be installed first and ideally in a virtual environment. The following commands will create a virtual environment and install the necessary packages: ```bash -make -C CI/doc gen_hdl_refdesigns html +python3 -m venv venv +source venv/bin/activate +pip install -r CI/doc/requirements_doc.txt +``` + +Next we can build the documentation. The following commands will build the documentation and place it in the *build* folder under the *CI/doc* folder: + +```bash +make -C CI/doc gen_autodocs html ``` ## Updating the System Object Documentation