Skip to content
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

Standardize Sphinx documentation and add doxygen integration via doxysphinx #243

Merged
merged 2 commits into from
Oct 29, 2023

Conversation

samjwu
Copy link
Member

@samjwu samjwu commented Oct 27, 2023

Relates to ROCm/rocm-docs-core#330

Apply the following to repo docs:
add version number to documentation left navigation bar and page title
add an "About" section with a license page
enable htmlzip, pdf, epub formats when publishing on Read the Docs
set pdf title, author, copyright, and version
rename .sphinx/.doxygen to sphinx/doxygen
remove docBin from URL
update rocm-docs-core dependency
update dependabot config

@samjwu samjwu added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file ci:docs-only Only run Read the Docs CI for this PR labels Oct 27, 2023
@samjwu samjwu requested a review from kiritigowda October 27, 2023 15:52
@samjwu samjwu self-assigned this Oct 27, 2023
@samjwu samjwu requested a review from saadrahim as a code owner October 27, 2023 15:52
@samjwu
Copy link
Member Author

samjwu commented Oct 27, 2023

Also adds API docs: https://advanced-micro-devices-demo--243.com.readthedocs.build/projects/rpp/en/243/doxygen/html/index.html

@kiritigowda kiritigowda merged commit 992c552 into ROCm:develop Oct 29, 2023
@samjwu samjwu deleted the rtd branch October 30, 2023 15:21
kiritigowda pushed a commit that referenced this pull request Oct 31, 2023
…gration via doxysphinx (#243)

* Standardize Sphinx documentation and add doxygen integration via doxysphinx

Relates to ROCm/rocm-docs-core#330

* Include api_reference in requirements.in for doxysphinx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs-only Only run Read the Docs CI for this PR dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants