Skip to content

Commit

Permalink
Update doc about generating doc
Browse files Browse the repository at this point in the history
Signed-off-by: Travis F. Collins <[email protected]>
  • Loading branch information
tfcollins committed Jan 24, 2024
1 parent 2d36224 commit 58e6d0e
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions CI/doc/README_doc.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 58e6d0e

Please sign in to comment.