Files
mscclpp/docs
caiomcbr b1b9d0626c Support NCCL APIs (#319)
Start supporting NCCL APIs with a few limitations.

---------

Co-authored-by: Caio Rocha <caio.rocha@microsoft.com>
Co-authored-by: Changho Hwang <changhohwang@microsoft.com>
2024-06-27 23:54:06 +00:00
..
2023-11-22 12:58:04 -08:00
2023-11-22 12:58:04 -08:00
2024-05-26 14:31:29 -07:00
2023-11-22 12:58:04 -08:00
2023-11-22 12:58:04 -08:00
2023-11-22 12:58:04 -08:00
2023-11-22 12:58:04 -08:00
2024-06-27 23:54:06 +00:00
2023-11-22 12:58:04 -08:00

How to build docs

  1. Install doxygen.

    $ sudo apt-get install doxygen
    
  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 sphinx sphinx_rtd_theme breathe
    
  3. Create Doxygen documents.

    $ doxygen
    
  4. Create Sphinx documents.

    $ sphinx-build -b html -Dbreathe_projects.mscclpp=$PWD/doxygen/xml $PWD $PWD/sphinx
    
  5. Done. The HTML files will be on sphinx/ directory.