mirror of
https://github.com/microsoft/mscclpp.git
synced 2026-05-11 17:00:22 +00:00
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>
521 B
521 B
How to build docs
-
Install
doxygen.$ sudo apt-get install doxygen graphviz -
Install Python packages below. If you install them on the user's local, you need to include
~/.local/binto$PATH(to usesphinx-build).$ sudo python3 -m pip install -r ./requirements.txt -
Create Doxygen documents.
$ doxygen -
Create Sphinx documents.
$ make html -
Done. The HTML files will be on
_build/directory.