Skip to content

Commit

Permalink
Cherry pick docs reorg changes for 6.1.0 (#389)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
5 people authored Apr 15, 2024
1 parent 988b1c8 commit 8f9fbf5
Show file tree
Hide file tree
Showing 20 changed files with 748 additions and 966 deletions.
8 changes: 7 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@
version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/docs/.sphinx" # Location of package manifests
directory: "/docs/sphinx" # Location of package manifests
open-pull-requests-limit: 10
schedule:
interval: "daily"
labels:
- "documentation"
- "dependencies"
- "ci:docs-only"
reviewers:
- "samjwu"
10 changes: 0 additions & 10 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,13 +47,3 @@ build*
\#*\#
*~
*.log

# documentation artifacts
build/
_build/
_images/
_static/
_templates/
_toc.yml
docBin/
_doxygen/
6 changes: 3 additions & 3 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ version: 2
sphinx:
configuration: docs/conf.py

formats: [htmlzip]
formats: [htmlzip, pdf, epub]

python:
install:
- requirements: docs/.sphinx/requirements.txt
- requirements: docs/sphinx/requirements.txt

build:
os: ubuntu-20.04
os: ubuntu-22.04
tools:
python: "3.8"
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ To build our documentation locally, use the following commands.
```bash
cd docs

pip3 install -r .sphinx/requirements.txt
pip3 install -r sphinx/requirements.txt

python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
```
Expand Down Expand Up @@ -769,7 +769,7 @@ The HIP runtime compilation (hipRTC) environment allows simultaneous compilation
running of device code on AMD GPUs. The rocWMMA library is compatible with hipRTC, so you can
leverage it for runtime-generated kernels. A simple GEMM sample is included to demonstrate
compatibility. For more information, refer to the
[HIP API reference](https://rocm.docs.amd.com/projects/HIP/en/latest/.doxygen/docBin/html/index.html).
[HIP API reference](https://rocm.docs.amd.com/projects/HIP/en/latest/doxygen/html/index.html).
```important
The `rocwmma::bfloat16_t` data type is not currently supported in hipRTC.
Expand Down
6 changes: 6 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# documentation artifacts
_build/
_doxygen/
sphinx/_toc.yml
doxygen/html/
doxygen/xml/
3 changes: 0 additions & 3 deletions docs/.sphinx/_toc.yml.in

This file was deleted.

Loading

0 comments on commit 8f9fbf5

Please sign in to comment.