Skip to content

docs: Update configs for documentation to host on Read the Docs - #981

Open
peterjunpark wants to merge 8 commits into
mainfrom
docs/setup-rtd
Open

docs: Update configs for documentation to host on Read the Docs#981
peterjunpark wants to merge 8 commits into
mainfrom
docs/setup-rtd

Conversation

@peterjunpark

Copy link
Copy Markdown

Motivation

  • Use ROCm docs theme
  • Add Read the Docs config

Technical Details

Test Plan

Test Result

Submission Checklist

Copilot AI lite review requested due to automatic review settings August 7, 2026 18:39

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.py to rocm_docs_theme / rocm_docs extension and introduce external ToC + version substitution.
  • Add RTD build config and a pinned Sphinx requirements set (requirements.in + compiled requirements.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.

Comment thread docs/conf.py
Comment thread docs/sphinx/_toc.yml.in Outdated
Comment thread docs/conf.py
Comment thread docs/.readthedocs.yaml
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@peterjunpark

peterjunpark commented Aug 7, 2026

Copy link
Copy Markdown
Author

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