Skip to content

Add documentation for MkDocs setup and API reference#257

Merged
LoserCheems merged 6 commits intomainfrom
optim_triton_version
Mar 23, 2026
Merged

Add documentation for MkDocs setup and API reference#257
LoserCheems merged 6 commits intomainfrom
optim_triton_version

Conversation

@LoserCheems
Copy link
Collaborator

Enhance project documentation by adding MkDocs configuration, initial index, and API reference generated from Python docstrings. Include a GitHub Actions workflow for automated documentation publishing. This update improves accessibility and usability of the documentation.

Copilot AI review requested due to automatic review settings March 23, 2026 03:57
@LoserCheems LoserCheems merged commit b94081a into main Mar 23, 2026
2 checks passed
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds an MkDocs-based documentation site (Material theme) with mkdocstrings-generated API reference, plus a GitHub Actions workflow to build and publish the docs to GitHub Pages.

Changes:

  • Add a docs optional-dependency group in pyproject.toml for MkDocs/mkdocstrings tooling.
  • Introduce mkdocs.yml and initial docs pages (docs/index.md, docs/api.md) including mkdocstrings directives.
  • Add .github/workflows/docs.yml to build the site and deploy it to GitHub Pages on pushes/tags.

Reviewed changes

Copilot reviewed 5 out of 7 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
pyproject.toml Adds docs extras for MkDocs, Material theme, mkdocstrings, and markdown extensions.
mkdocs.yml Defines MkDocs site configuration, theme, mkdocstrings plugin, and navigation.
docs/index.md Adds a documentation landing page and local preview instructions.
docs/api.md Adds mkdocstrings-based API reference entries for package + Triton interface.
.github/workflows/docs.yml Builds MkDocs site in CI and deploys to GitHub Pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +40 to +42
nav:
- API: api.md

Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nav only includes api.md, so docs/index.md (and existing hand-written docs like docs/api_reference*.md) won’t appear in the generated site when nav is defined. This conflicts with the stated goal of combining existing docs + generated API and also makes the homepage inaccessible from the navigation. Consider adding index.md (Home) and the existing documentation pages to nav (or removing nav until the structure is defined).

Suggested change
nav:
- API: api.md

Copilot uses AI. Check for mistakes.
Comment on lines +37 to +48
- name: Install documentation dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material "mkdocstrings[python]" pymdown-extensions

- name: Install runtime imports needed for API docs
run: |
pip install torch --index-url https://download.pytorch.org/whl/cpu
pip install triton

- name: Install package without dependency resolution
run: pip install -e . --no-deps
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow installs MkDocs dependencies by hand, even though a docs extra was added to pyproject.toml. This duplicates the dependency list and can drift (e.g., local pip install -e .[docs] vs CI). Consider installing .[docs] in the workflow (and relying on the project’s version constraints) and only separately installing runtime-only deps that aren’t declared (e.g., torch if intentionally not a package dependency).

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants