mirror of
https://github.com/microsoft/mscclpp.git
synced 2026-05-12 01:10:22 +00:00
4136153a76
Generate docs for mescclpp. Setup github action to auto-deploy github-page doc link here: https://microsoft.github.io/mscclpp --------- Co-authored-by: Changho Hwang <changhohwang@microsoft.com> Co-authored-by: Caio Rocha <caiorocha@microsoft.com>
28 lines
521 B
Markdown
28 lines
521 B
Markdown
## How to build docs
|
|
|
|
1. Install `doxygen`.
|
|
|
|
```bash
|
|
$ sudo apt-get install doxygen graphviz
|
|
```
|
|
|
|
2. Install Python packages below. If you install them on the user's local, you need to include `~/.local/bin` to `$PATH` (to use `sphinx-build`).
|
|
|
|
```bash
|
|
$ sudo python3 -m pip install -r ./requirements.txt
|
|
```
|
|
|
|
3. Create Doxygen documents.
|
|
|
|
```bash
|
|
$ doxygen
|
|
```
|
|
|
|
4. Create Sphinx documents.
|
|
|
|
```bash
|
|
$ make html
|
|
```
|
|
|
|
5. Done. The HTML files will be on `_build/` directory.
|