Files
mscclpp/docs/index.rst

30 lines
1.1 KiB
ReStructuredText

.. MSCCL++ documentation master file, created by
sphinx-quickstart on Tue Sep 5 13:03:46 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
MSCCL++ Documentation
=====================
You can find the followings from this documentation.
- **Overview:** An overview of MSCCL++ and its features. :doc:`🔗 <overview>`
- **Quick Start:** A guide to build, install, and run MSCCL++. :doc:`🔗 <quickstart>`
- **MSCCL++ DSL:** A guide to get started with the MSCCL++ DSL. :doc:`🔗 <dsl>`
- **Tutorials:** A step-by-step guide for GPU communication using MSCCL++. :doc:`🔗 <tutorials>`
- **Programming Guide:** Advanced topics and best practices for using MSCCL++. :doc:`🔗 <programming_guide>`
- **C++ API Reference:** Detailed documentation of the MSCCL++ C++ API. :doc:`🔗 <cpp_api>`
- **Python API Reference:** Detailed documentation of the MSCCL++ Python API. :doc:`🔗 <py_api>`
.. toctree::
:maxdepth: 1
:hidden:
overview
quickstart
dsl
tutorials
programming_guide
cpp_api
py_api