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.40.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.40.0-py3-none-any.whl (1.4 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rocm_docs_core-1.40.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.40.0.tar.gz
Algorithm Hash digest
SHA256 a8db4484f40a876c2786b9e1ec730d24eb6061c21994f49e4066831da965764b
MD5 a58461379e923cf2403e1bb1575ee3cb
BLAKE2b-256 4d6faadb2436f7d92cc3595c0740d46735a2d87165c7e54a8ac8c54afdf5c4e5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for rocm_docs_core-1.40.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc1de5968aefa2a87b22f6865083052ab433d14f9829072abdf4a641b854e212
MD5 51256e18a09eaf0b2e27f5fcf0cad055
BLAKE2b-256 2310b7994e00ce58ea7d81d9370a1ed532da7c4d10a32c2c7c7a194d2ec61bce

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

1.40.0 This release

2 files

1.39.0

2 files

1.38.0

2 files

1.37.0

2 files

1.36.0

2 files

1.35.0

2 files

1.33.1

2 files

1.33.0

2 files

1.32.1

2 files

1.32.0

2 files

1.31.3

2 files

1.31.2

2 files

1.31.1

2 files

1.31.0

2 files

1.30.1

2 files

1.30.0

2 files

1.29.0

2 files

1.28.0

2 files

1.27.0

2 files

1.26.0

2 files

1.25.0

2 files

1.24.1

2 files

1.24.0

2 files

1.23.0

2 files

1.22.0

2 files

1.21.1

2 files

1.21.0

2 files

1.20.1

2 files

1.20.0

2 files

1.19.1

2 files

1.19.0

2 files

1.18.4

2 files

1.18.3

2 files

1.18.2

2 files

1.18.1

2 files

1.18.0

2 files

1.17.1

2 files

1.17.0

2 files

1.15.0

2 files

1.14.1

2 files

1.14.0

2 files

1.13.0

2 files

1.12.1

2 files

1.12.0

2 files

1.11.0

2 files

1.10.0

2 files

1.9.2

2 files

1.9.1

2 files

1.9.0

2 files

1.8.5

2 files

1.8.4

2 files

1.8.3

2 files

1.8.2

2 files

1.8.1

2 files

1.8.0

2 files

1.7.2

2 files

1.7.1

2 files

1.7.0

2 files

1.6.2

2 files

1.6.1

2 files

1.6.0

2 files

1.5.1

2 files

1.5.0

2 files

1.4.1

2 files

1.4.0

2 files

1.3.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

1.0.0

2 files

0.38.1

2 files

0.38.0

2 files

0.37.1

2 files

0.37.0

2 files

0.36.0

2 files

0.35.1

2 files

0.35.0

2 files

0.34.2

2 files

0.34.1

2 files

0.34.0

2 files

0.33.2

2 files

0.33.1

2 files

0.33.0

2 files

0.32.0

2 files

0.31.0

2 files

0.30.3

2 files

0.30.2

2 files

0.30.1

2 files

0.30.0

2 files

0.29.0

2 files

0.28.0

2 files

0.27.0

2 files

0.26.0

2 files

0.25.0

2 files

0.24.2

2 files

0.24.1

2 files

0.24.0

2 files

0.23.0

2 files

0.22.1

2 files

0.22.0

2 files

0.21.0

2 files

0.20.0

2 files

0.19.0

2 files

0.18.4

2 files

0.18.3

2 files

0.18.2

2 files

0.18.1

2 files

0.18.0

2 files

0.17.2

2 files

0.17.1

2 files

0.17.0

2 files

0.16.0

2 files

0.15.0

2 files

0.14.0

2 files

0.13.4

2 files

0.13.3

2 files

0.13.2

2 files

0.13.1

2 files

0.13.0

2 files

0.12.0

2 files

0.11.1

2 files

0.11.0

2 files

0.10.3

2 files

0.10.2

2 files

0.10.1

2 files

0.10.0

2 files

0.9.2

2 files

0.9.1

2 files

0.9.0

2 files

0.8.0

2 files

0.7.1

2 files

Yanked

0.7.0

2 files

Yanked reason: broken dependency chain

0.6.0

2 files

0.5.0

2 files

0.4.0

2 files

Yanked

0.3.0

2 files

Yanked reason: broken

Yanked

0.2.2

2 files

Yanked reason: broken

Yanked

0.2.1

2 files

Yanked reason: broken

0.2.0

2 files

Supported by

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