Core utilities for all ROCm documentation on RTD
Project description
ROCm Documentation Core Utilities
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.
Common elements covered
- Javascript tweaks for tables with long variable names, as Sphinx' default rendering is problematic.
- HTML for a header and footer for the documentation page.
- Common Sphinx configuration options for ROCm documentation processes.
Use
- Install this repository as a Python package using pip, for example
pip install git+https://github.com/RadeonOpenCompute/rocm-docs-core.git
. - From the
rocm_docs
package import the functionsetup_rocm_docs
intoconf.py
for the ReadTheDocs project. - Call exactly the following, replacing
<PROJECT NAME HERE>
with the name of the project.
from rocm_docs import ROCmDocs
docs_core = ROCmDocs(<PROJECT NAME HERE>)
docs_core.run_doxygen() # Only if Doxygen is required for this project
docs_core.setup()
for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
Documentation
Build documentation by running 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 details
Release history Release notifications | RSS feed
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-0.13.2.tar.gz
(1.1 MB
view hashes)
Built Distribution
Close
Hashes for rocm_docs_core-0.13.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6524b252fe8fd5c6c030abb0f5e7d5c9386128d2e3670076637983760b6f308b |
|
MD5 | fa4e0c5db0f8c9343e379a72e3da39cc |
|
BLAKE2b-256 | f69ee32f11409f491e12e5b49b621fe0dc4371299ec11257fb943d8cf7c99d9c |