mscclpp

mirror of https://github.com/microsoft/mscclpp.git synced 2026-05-12 09:17:06 +00:00

Files

Qinghua Zhou f0441ee4ea Update document versioning for PR #724 (#735 )

This PR fix the issue of generating docs when we take
https://github.com/microsoft/mscclpp/pull/724 into main branch.
Build docs for main branch separately.
Use HEAD request instead of GET to check if a page exist.
Filter out versions before v0.4.0 in generate_versions.py.

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Binyang Li <binyli@microsoft.com>

2026-02-01 19:52:01 -08:00

_static

Update document versioning for PR #724 (#735 )

2026-02-01 19:52:01 -08:00

dsl

Torch integration (#692 )

2026-01-21 20:32:24 -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

Torch integration (#692 )

2026-01-21 20:32:24 -08:00

.gitignore

python doc auto generation (#605 )

2025-08-11 10:34:29 -07:00

conf.py

Update document versioning for PR #724 (#735 )

2026-02-01 19:52:01 -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

Fix docs (#656 )

2025-10-23 00:34:53 +00:00

quickstart.md

Torch integration (#692 )

2026-01-21 20:32:24 -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

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/bin to $PATH (to use sphinx-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.