microsoft/mscclpp
1
0
Fork 0
mirror of https://github.com/microsoft/mscclpp.git synced 2026-05-12 01:10:22 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
48235835871849f20677a7cd5e6f74499206eb82
mscclpp/docs
History
Binyang Li e21513791a Address comments for PR #692 (#733) 
Rename nanobind-exposed C++ types to Cpp*
Replace MSCCLPP_EXECUTION_PLAN_DIR / MSCCLPP_NATIVE_CACHE_DIR with
MSCCLPP_CACHE_DIR across C++ and Python.
2026-02-03 10:13:20 -08:00
..
_static
Fix the relative path extraction on github page (#739)
2026-02-02 13:16:11 -08:00
dsl
Address comments for PR #692 (#733)
2026-02-03 10:13:20 -08:00
figs
Torch integration (#692)
2026-01-21 20:32:24 -08:00
guide
Torch integration (#692)
2026-01-21 20:32:24 -08:00
tutorials
Support multi-node in MemoryChannel tutorial (#726)
2026-02-02 15:50:45 -08:00
.gitignore
python doc auto generation (#605)
2025-08-11 10:34:29 -07:00
conf.py
Address comments for PR #692 (#733)
2026-02-03 10:13:20 -08:00
cpp_api.rst
Fix docs (#656)
2025-10-23 00:34:53 +00:00
Doxyfile
Fix docs (#656)
2025-10-23 00:34:53 +00:00
dsl.rst
Improve DSL Documentation (#707)
2025-12-19 15:17:08 -08:00
generate_versions.py
Update document versioning for PR #724 (#735)
2026-02-01 19:52:01 -08:00
index.rst
Creating Documentation Section for MSCCL++ DSL (#706)
2025-12-15 15:07:01 -08:00
make.bat
Update documentation (#217)
2023-11-22 12:58:04 -08:00
Makefile
Update document versioning for PR #724 (#735)
2026-02-01 19:52:01 -08:00
overview.md
Update documentation (#576)
2025-08-07 15:37:37 -07:00
programming_guide.rst
Torch integration (#692)
2026-01-21 20:32:24 -08:00
py_api.rst
Address comments for PR #692 (#733)
2026-02-03 10:13:20 -08:00
quickstart.md
Address comments for PR #692 (#733)
2026-02-03 10:13:20 -08:00
README.md
[Doc] mscclpp docs (#348)
2024-10-18 06:08:31 +00:00
requirements.txt
Update document versioning for PR #724 (#735)
2026-02-01 19:52:01 -08:00
tutorials.rst
Update documentation (#576)
2025-08-07 15:37:37 -07:00

README.md

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.

Reference in New Issue View Git Blame Copy Permalink