docs: Update configs for documentation to host on Read the Docs - #981
Open
peterjunpark wants to merge 8 commits into
Open
docs: Update configs for documentation to host on Read the Docs#981peterjunpark wants to merge 8 commits into
peterjunpark wants to merge 8 commits into
Conversation
add sphinx-autodoc-typehints
add titles add missing file
conf
peterjunpark
force-pushed
the
docs/setup-rtd
branch
from
August 7, 2026 18:39
2a84fa4 to
d8a75b0
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Sphinx documentation configuration to use the ROCm docs theme and introduces Read the Docs configuration/dependency pinning to enable hosting docs builds on RTD.
Changes:
- Switch
docs/conf.pytorocm_docs_theme/rocm_docsextension and introduce external ToC + version substitution. - Add RTD build config and a pinned Sphinx requirements set (
requirements.in+ compiledrequirements.txt). - Replace the landing-page toctree structure with an external
_toc.yml-driven nav, and remove the old tutorials index page.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
docs/conf.py |
Switches to ROCm docs theme/extension; adds external ToC + version substitution. |
docs/index.rst |
Updates index title/content to rely on external ToC navigation. |
docs/sphinx/_toc.yml.in |
Adds an external ToC structure for site navigation. |
docs/sphinx/requirements.in |
Introduces minimal input requirements for doc builds. |
docs/sphinx/requirements.txt |
Adds pip-compiled, fully pinned doc build dependencies. |
docs/.readthedocs.yaml |
Adds RTD build configuration. |
docs/kernel_authoring_guide.md |
Fixes an internal anchor link to match generated heading ID. |
docs/tutorials/index.rst |
Removes the old tutorials landing page (previously used by toctree). |
.gitignore |
Ignores generated _toc.yml. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Technical Details
Test Plan
Test Result
Submission Checklist