ROCm Documentation Core Utilities
ROCm Docs Core is also distributed as a pip package available from PyPi as rocm-docs-core
Purpose
This repository is comprised of utilities, styling, scripts, and additional HTML content that is common to all ROCm projects' documentation. This greatly aids in maintaining the documentation, as any change to the appearance only needs to be modified in one location.
Usage
Setup
-
Install this repository as a Python package using pip
- From PyPi:
pip install rocm-docs-core - From GitHub:
pip install git+https://github.com/ROCm/rocm-docs-core.git.
- From PyPi:
-
Set
rocm_docs_themeas the HTML theme -
Add
rocm_docsas an extension -
Optionally, add
rocm_docs.doxygenandsphinxcontrib.doxylinkas extensions
For an example, see the test conf.py
Legacy Setup
- From the
rocm_docspackage import the functionsetup_rocm_docsintoconf.pyfor the ReadTheDocs project. - Call exactly the following, replacing
<PROJECT NAME HERE>with the name of the project.
For an example, see the test legacy conf.py
Documentation
The rocm-docs-core documentation is viewable at https://rocm.docs.amd.com/projects/rocm-docs-core/en/latest/
User Guide
The User Guide describes how users can make use of functionality in rocm-docs-core
It is viewable at https://rocm.docs.amd.com/projects/rocm-docs-core/en/latest/user_guide/user_guide.html
Developer Guide
The Developer Guide provides additional information on the processes in toolchains for rocm-docs-core
It is viewable at https://rocm.docs.amd.com/projects/rocm-docs-core/en/latest/developer_guide/developer_guide.html
Build Documentation Locally
To build the rocm-docs-core documentation locally, run the commands below:
pip install -r requirements.txt
cd docs
python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
5 maintainers
Release files for rocm-docs-core 1.41.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rocm_docs_core-1.41.0.tar.gz | 1.4 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rocm_docs_core-1.41.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.7 MB
Release files / rocm_docs_core-1.41.0.tar.gz
| Download URL | rocm_docs_core-1.41.0.tar.gz |
|---|---|
| Size | 1.4 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c1ab9efad843c5012a4d6c8d21099188b421eb7a7c7e497fddebd71248c5dce1
|
|
BLAKE2b-256 checksum How to use checksums |
f2b6544806ef315b084dc8eca4c01db2ea9b118b2b37c0d6f215c05ddfce4517
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Release files / rocm_docs_core-1.41.0-py3-none-any.whl
| Download URL | rocm_docs_core-1.41.0-py3-none-any.whl |
|---|---|
| Size | 1.4 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ed918220685de5ef45883d647082e49557702e914e9542112620fa20fe6c78b1
|
|
BLAKE2b-256 checksum How to use checksums |
41331495d457cc89343df6c8ef799ef138b4f3bb7faad91d49303406d99ed43b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
