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 #97

Merged
merged 1 commit into from
Jan 15, 2024
Merged

Conversation

samjwu
Copy link
Member

@samjwu samjwu commented Dec 29, 2023

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
remove docBin from URL
update rocm-docs-core dependency
update dependabot config

Relates to ROCm/rocm-docs-core#330

@samjwu samjwu merged commit 3cbf01f into ROCm:develop Jan 15, 2024
10 of 12 checks passed
@samjwu samjwu deleted the rtd branch January 15, 2024 18:24
yhuiYH pushed a commit that referenced this pull request Apr 17, 2024
yhuiYH added a commit that referenced this pull request Apr 17, 2024
* Standardize documentation for ReadtheDocs (#97)

* Update link (#112)

* update ROCm naming (#95)

* Add documentation for supported data types

* Update docs/data-type-support.rst

Co-authored-by: MKKnorr <MKKnorr@web.de>

* Update docs/data-type-support.rst

Co-authored-by: MKKnorr <MKKnorr@web.de>

* Update docs/data-type-support.rst

* Update docs/data-type-support.rst

Fix link of ROCm data type support page

* Add linkable documentation to opaque device generator state types

* Use shell .. code-block:: shellcode-blocks in installing of rst instead of verbatim text

* Clarify when and why CMAKE_NO_SYSTEM_FROM_IMPORTED is recommended

* Fixed deprecated URLs

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

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: Lisa <lisajdelaney@gmail.com>
Co-authored-by: Istvan Kiss <neon60@gmail.com>
Co-authored-by: Istvan Kiss <istvan@streamhpc.com>
Co-authored-by: MKKnorr <MKKnorr@web.de>
Co-authored-by: Matthias Knorr <matthias@streamhpc.com>
Co-authored-by: Gergely Meszaros <gergely@streamhpc.com>
Co-authored-by: Lőrinc Serfőző <lorinc@streamhpc.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
yhuiYH added a commit that referenced this pull request May 22, 2024
* Standardize documentation for ReadtheDocs (#97)

* Update link (#112)

* update ROCm naming (#95)

* Add documentation for supported data types

* Update docs/data-type-support.rst

Co-authored-by: MKKnorr <MKKnorr@web.de>

* Update docs/data-type-support.rst

Co-authored-by: MKKnorr <MKKnorr@web.de>

* Update docs/data-type-support.rst

* Update docs/data-type-support.rst

Fix link of ROCm data type support page

* Add linkable documentation to opaque device generator state types

* Use shell .. code-block:: shellcode-blocks in installing of rst instead of verbatim text

* Clarify when and why CMAKE_NO_SYSTEM_FROM_IMPORTED is recommended

* Fixed deprecated URLs

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

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: Lisa <lisajdelaney@gmail.com>
Co-authored-by: Istvan Kiss <neon60@gmail.com>
Co-authored-by: Istvan Kiss <istvan@streamhpc.com>
Co-authored-by: MKKnorr <MKKnorr@web.de>
Co-authored-by: Matthias Knorr <matthias@streamhpc.com>
Co-authored-by: Gergely Meszaros <gergely@streamhpc.com>
Co-authored-by: Lőrinc Serfőző <lorinc@streamhpc.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
yhuiYH added a commit that referenced this pull request May 23, 2024
* Cherry pick doc changes into docs/6.1.0 (#131)

* Standardize documentation for ReadtheDocs (#97)

* Update link (#112)

* update ROCm naming (#95)

* Add documentation for supported data types

* Update docs/data-type-support.rst

Co-authored-by: MKKnorr <MKKnorr@web.de>

* Update docs/data-type-support.rst

Co-authored-by: MKKnorr <MKKnorr@web.de>

* Update docs/data-type-support.rst

* Update docs/data-type-support.rst

Fix link of ROCm data type support page

* Add linkable documentation to opaque device generator state types

* Use shell .. code-block:: shellcode-blocks in installing of rst instead of verbatim text

* Clarify when and why CMAKE_NO_SYSTEM_FROM_IMPORTED is recommended

* Fixed deprecated URLs

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

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: Lisa <lisajdelaney@gmail.com>
Co-authored-by: Istvan Kiss <neon60@gmail.com>
Co-authored-by: Istvan Kiss <istvan@streamhpc.com>
Co-authored-by: MKKnorr <MKKnorr@web.de>
Co-authored-by: Matthias Knorr <matthias@streamhpc.com>
Co-authored-by: Gergely Meszaros <gergely@streamhpc.com>
Co-authored-by: Lőrinc Serfőző <lorinc@streamhpc.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* refactor hipRAND documentation

* Update _toc.yml.in

* refactor doc

* Update data-type-support.rst

* Update data-type-support.rst

* refactor doc

* Update installation.rst

* Update data-type-support.rst

* update rocm-docs-core to ver 1.1.2

* update requirements to add doxygen

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Sam Wu <sam.wu2@amd.com>
Co-authored-by: Lisa <lisajdelaney@gmail.com>
Co-authored-by: Istvan Kiss <neon60@gmail.com>
Co-authored-by: Istvan Kiss <istvan@streamhpc.com>
Co-authored-by: MKKnorr <MKKnorr@web.de>
Co-authored-by: Matthias Knorr <matthias@streamhpc.com>
Co-authored-by: Gergely Meszaros <gergely@streamhpc.com>
Co-authored-by: Lőrinc Serfőző <lorinc@streamhpc.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: srawat <120587655+SwRaw@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants