roland/xo-alloc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

xo-unit: README: instructions for building sphinx docs

Browse source
This commit is contained in:
Roland Conybeare 2024-04-02 17:29:52 -04:00
commit 183da6b29b
1 changed files with 7 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -23,6 +23,13 @@ $ make
$ make install
```
### build documentation
```
$ cd xo-unit
$ cmake --build .build -- sphinx
```
When this completes, point local browser to `xo-unit/.build/docs/sphinx/index.html`.
### build for unit test coverage
```
$ cd xo-unit