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 documentation for ReadtheDocs #323

Merged
merged 1 commit into from
Jan 12, 2024
Merged

Conversation

samjwu
Copy link
Member

@samjwu samjwu commented Jan 12, 2024

Apply the following changes to project documentation for ReadtheDocs:

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
update rocm-docs-core dependency
update dependabot config

related to ROCm/rocm-docs-core#330

@samjwu samjwu added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file ci:docs-only Skip most non-doc CI on this PR labels Jan 12, 2024
@samjwu samjwu self-assigned this Jan 12, 2024
@samjwu samjwu merged commit 630f396 into ROCm:develop Jan 12, 2024
8 checks passed
@samjwu samjwu deleted the rtd branch January 12, 2024 23:13
cgmillette pushed a commit to cgmillette/rocWMMA that referenced this pull request Mar 6, 2024
yhuiYH added a commit that referenced this pull request Apr 15, 2024
* Standardize documentation for ReadtheDocs (#323)

* refactor rocWMMA documentation (#365)

* refactor rocWMMA

* refactoring

* refactor

* Update installation.rst

* Update _toc.yml.in

---------

Co-authored-by: Christopher Millette <63608002+cgmillette@users.noreply.github.com>

* Bump rocm-docs-core from 0.38.0 to 0.38.1 in /docs/sphinx (#385)

Bumps [rocm-docs-core](https://github.com/RadeonOpenCompute/rocm-docs-core) from 0.38.0 to 0.38.1.
- [Release notes](https://github.com/RadeonOpenCompute/rocm-docs-core/releases)
- [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md)
- [Commits](ROCm/rocm-docs-core@v0.38.0...v0.38.1)

---
updated-dependencies:
- dependency-name: rocm-docs-core
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Sam Wu <sam.wu2@amd.com>
Co-authored-by: srawat <120587655+SwRaw@users.noreply.github.com>
Co-authored-by: Christopher Millette <63608002+cgmillette@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci:docs-only Skip most non-doc CI on 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