Review updated until commit c452481

Description

• Add Sphinx-based documentation for NvFuser

• Include API reference for enums and operations

• Style customization with NVIDIA branding

• Setup build system and templates for docs

Changes walkthrough 📝

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

extensions = [
    "myst_parser",
    "sphinx.ext.mathjax",
    "sphinx.ext.autodoc",
    "sphinx.ext.napoleon",
    "sphinx.ext.viewcode",
    "sphinx.ext.intersphinx",
    "sphinx_toolbox.more_autodoc.overloads",
]

pip install --upgrade Sphinx furo pandoc myst-parser sphinx-copybutton nbsphinx nbsphinx-link sphinx-inline-tabs

!build

I'm not familiar with Sphinx enough to review this PR, but is it possible to host the doc somewhere and make it automatically updated? Can we use Github pages?

Similar to Naoya's question, what's the overhead of maintaining these docs? Do you expect

pip install --upgrade Sphinx myst-parser
cd docs/sphinx
make html

to be run automatically after each Python API change?

Some thoughts for reviewers:

• A technical review isn't required for this PR. The RST files are the code for sphinx and are straightforward.
• Do you have an opinion on using Sphinx or some other tool?
• Which design layout do we want? I picked the template from TransformerEngine. This corresponds with source/_static and source/_templates.
• What do you we want to include in the docs in the future? For example, convert tests/cpp/tutorial.cpp into jupyter notebooks.

host the doc somewhere

I don't know much about hosting the docs on an Nvidia site. This is TBD once the docs are polished. I'd imagine we'd need some third-party review before posting it.

make it automatically updated?

@xwang233 has a Gitlab pipeline to push NvFuser pip wheels. I think we can do something similar for the docs. Furthermore, we can push major releases each quarter.

generating document with sphinx is lightweight, we can add a GitHub CI action on main branch and it will rebuild doc after every commit.

If we want to host the doc in public, the easiest solution is to use GitHub pages from this repo. Should be easy to do, not a problem.