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.

  • Set rocm_docs_theme as the HTML theme

  • Add rocm_docs as an extension

  • Optionally, add rocm_docs.doxygen and sphinxcontrib.doxylink as extensions

For an example, see the test conf.py

Legacy Setup

  • From the rocm_docs package import the function setup_rocm_docs into conf.py for 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

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

5 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for alexxu-amd from gravatar.com alexxu-amd Avatar for ashequr from gravatar.com ashequr Avatar for lwrubles from gravatar.com lwrubles
+2 more Avatar for Maetveis from gravatar.com Maetveis Avatar for samjwu from gravatar.com samjwu

Credits

Author: Lauren Wrubleski

License

MIT License

Requires

Python >=3.10

Provides Extra

api-reference llms development

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rocm_docs_core-1.39.0.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rocm_docs_core-1.39.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file rocm_docs_core-1.39.0.tar.gz.

File metadata

  • Download URL: rocm_docs_core-1.39.0.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rocm_docs_core-1.39.0.tar.gz
Algorithm Hash digest
SHA256 6b4a6d677867c5df835013518042a11baa3ebe3c4f30a5c3c8d73e217f72c8b5
MD5 a7908384a8e5bd41b5f5d4db689f2bfe
BLAKE2b-256 749e7ad0924b18a74ec5f0c1842f9242079c0ac71e8bb500127b7d17ae7a5e72

See more details on using hashes here.

File details

Details for the file rocm_docs_core-1.39.0-py3-none-any.whl.

File metadata

File hashes

Hashes for rocm_docs_core-1.39.0-py3-none-any.whl
Algorithm Hash digest
SHA256 42afc1333bc5be5b88c45bf22216e753bf6216c75e0d0e736b28f4c3bb71e755
MD5 8e068229a768afd82444424d1b95bc48
BLAKE2b-256 0539d485a119373b2080ebef0b2568569be858d447bfb4f1a7e5cdfe36864af6

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.39.0

1.38.0

1.37.0

1.36.0

1.35.0

1.33.1

1.33.0

1.32.1

1.32.0

1.31.3

1.31.2

1.31.1

1.31.0

1.30.1

1.30.0

1.29.0

1.28.0

1.27.0

1.26.0

1.25.0

1.24.1

1.24.0

1.23.0

1.22.0

1.21.1

1.21.0

1.20.1

1.20.0

1.19.1

1.19.0

1.18.4

1.18.3

1.18.2

1.18.1

1.18.0

1.17.1

1.17.0

1.15.0

1.14.1

1.14.0

1.13.0

1.12.1

1.12.0

1.11.0

1.10.0

1.9.2

1.9.1

1.9.0

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.2

1.7.1

1.7.0

1.6.2

1.6.1

1.6.0

1.5.1

1.5.0

1.4.1

1.4.0

1.3.0

1.2.1

1.2.0

1.1.3

1.1.2

1.1.1

1.1.0

1.0.0

0.38.1

0.38.0

0.37.1

0.37.0

0.36.0

0.35.1

0.35.0

0.34.2

0.34.1

0.34.0

0.33.2

0.33.1

0.33.0

0.32.0

0.31.0

0.30.3

0.30.2

0.30.1

0.30.0

0.29.0

0.28.0

0.27.0

0.26.0

0.25.0

0.24.2

0.24.1

0.24.0

0.23.0

0.22.1

0.22.0

0.21.0

0.20.0

0.19.0

0.18.4

0.18.3

0.18.2

0.18.1

0.18.0

0.17.2

0.17.1

0.17.0

0.16.0

0.15.0

0.14.0

0.13.4

0.13.3

0.13.2

0.13.1

0.13.0

0.12.0

0.11.1

0.11.0

0.10.3

0.10.2

0.10.1

0.10.0

0.9.2

0.9.1

0.9.0

0.8.0

0.7.1

0.7.0 yanked

Reason this release was yanked:

broken dependency chain

0.6.0

0.5.0

0.4.0

0.3.0 yanked

Reason this release was yanked:

broken

0.2.2 yanked

Reason this release was yanked:

broken

0.2.1 yanked

Reason this release was yanked:

broken

0.2.0

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page