Files
mscclpp/docs/README.md
Binyang Li 4136153a76 [Doc] mscclpp docs (#348)
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>
2024-10-18 06:08:31 +00:00

521 B

How to build docs

  1. Install doxygen.

    $ 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).

    $ sudo python3 -m pip install -r ./requirements.txt
    
  3. Create Doxygen documents.

    $ doxygen
    
  4. Create Sphinx documents.

    $ make html
    
  5. Done. The HTML files will be on _build/ directory.