Skip to content

Commit 9f3188f

Browse files
committed
docs(//docsrc): Documentation generator usage documenation
Signed-off-by: Naren Dasan <naren@narendasan.com> Signed-off-by: Naren Dasan <narens@nvidia.com>
1 parent 2c0df21 commit 9f3188f

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docsrc/README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Building the Documentation
2+
3+
We use Sphinx and Doxygen for documentation, so begin by installing the dependencies:
4+
5+
```
6+
apt install doxygen
7+
```
8+
9+
```
10+
pip3 install --user -r requirements.txt
11+
```
12+
13+
Then you just need to run the Makefile to generate the docs in `../docs`
14+
15+
There are two main relevant commands (other sphinx make commands are available)
16+
17+
### `make html`
18+
19+
> Make sure any time there is an API change you regenerate the master docs
20+
21+
`make html` builds the docs for the current branch and replaces the existing master branch documentation.
22+
23+
You can specify a version to build docs when cutting a release like this `make html VERSION=v0.0.1`
24+
This will place the documentation in `../docs/v0.0.1`, then you can update the `conf.py` to include
25+
the new version documentation in the dropdown.
26+
27+
### `make clean`
28+
29+
`make clean` will only delete the master documentation, not any of the version documentation
30+
31+
To clean version documentation use `make clean VERSION=v0.0.1`
32+
33+

0 commit comments

Comments
 (0)