Draft
Conversation
Also adds a blank hipify.rst file
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds initial Sphinx/Read the Docs scaffolding for hipFile documentation, including pinned Python doc dependencies, a Sphinx conf.py, a JupyterBook-style TOC, and a Doxygen configuration intended to feed API reference pages.
Changes:
- Add Read the Docs config and Sphinx configuration (
.readthedocs.yaml,docs/conf.py). - Add doc build inputs: Doxygen template, external TOC, and pinned Sphinx dependency set (
docs/doxygen/Doxyfile.in,docs/sphinx/*). - Add initial RST content for the docs landing page and API sections (
docs/index.rst,docs/api/*.rst, etc.).
Reviewed changes
Copilot reviewed 8 out of 17 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sphinx/requirements.txt | Pinned, compiled Python dependency set for building docs. |
| docs/sphinx/requirements.in | Source input for pip-compile (rocm-docs-core pin). |
| docs/sphinx/_toc.yml.in | External TOC definition for Sphinx (currently committed as .in). |
| docs/index.rst | New docs landing page and navigation grid. |
| docs/hipify.rst | Stub page for hipify docs section. |
| docs/doxygen/Doxyfile.in | Doxygen configuration template intended for API XML generation. |
| docs/conf.py | Sphinx configuration using rocm_docs helpers and Doxygen invocation. |
| docs/api/async.rst | Async API page (currently notes unsupported). |
| docs/api/batch.rst | Batch API page (currently notes unsupported). |
| docs/api/core.rst | Core API and versioning documentation. |
| docs/api/driver.rst | Driver API documentation. |
| docs/api/errors.rst | Error handling documentation. |
| docs/api/file.rst | File handle/buffer/IO operations documentation. |
| docs/api/misc_api.rst | Placeholder “Misc Notes” page. |
| docs/api/rdma.rst | RDMA page (currently notes unsupported). |
| cmake/AISDocumentation.cmake | Update Doxygen template path for CMake-driven doc builds. |
| .readthedocs.yaml | Read the Docs build configuration pointing at Sphinx config + requirements. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
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.
WIP