-
Notifications
You must be signed in to change notification settings - Fork 43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update documentation to match ROCm #142
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. One thing is that it will need an RTD config.
eg: https://github.com/RadeonOpenCompute/ROCm/blob/develop/.readthedocs.yaml
For the conf.py
, will likely want to call the ROCmDocs constructor (https://github.com/RadeonOpenCompute/rocm-docs-core#use)
eg: https://github.com/RadeonOpenCompute/ROCm/blob/develop/docs/conf.py
Thanks! Couldn't remember how to specify the build configuration.
Noting in advance that I wrote that particular usage guideline, I'm actually of the opinion that we should transition to using |
+1 |
RTD Builds for PRs have been enabled for this project. They should appear in the GitHub commit status and checks the next time this PR is updated. If not, closing and reopening the PR has worked in the past for triggering PR doc builds. |
@lawruble13 can this be merged soon? We need documentation for rocm-cmake soon. |
lawruble13#3 adds the yaml configuration for building on ReadtheDocs as well as some other changes from ROCm/rocm-docs-core#330 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think my only concern is that the src directory name ends up in the user-visible URL. If we can mitigate that, this is perfect.
To do that we would need to move the |
It's preferable to keep a consistent doc structure among the projects, but it's possible to move it. I am not sure if what would break rocm_add_sphinx_doc though. @lawruble13 thoughts? The external_toc_path and path to CMakeLists.txt in conf.py and sphinx.configuration in .readthedocs.yaml (and entries in _toc.yml.in) would have to be updated to match the new structure. |
It's a bit off-topic, but why are we using external_toc again? Does rocm-docs-core need to do something with it? |
rocm-docs-core has it as a dependency. The main advantage is ease of managing table of contents as they are defined in a single yaml file, compared to having toctrees in possibly multiple files |
Toctrees seem easier to manage as they are automatically generated from the included files. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@lawruble13, there seems to be both _toc.yml
and _toc.yml.in
?
Co-authored-by: Sam Wu <[email protected]>
* Update version number and changelog for ROCm 6.1 * Update documentation to match ROCm (#142) * Update documentation requirements files * Disable docsphinx test on macOS (#167) --------- Co-authored-by: Sam Wu <[email protected]>
The rocm-cmake documentation should be updated to match the documentation in the rest of ROCm, and be included on rocm.docs.amd.com.