v0.5.0

v0.5.0 (2023-04-14)

Feat

• init.py: add version numbers

Fix

• ensure compatibility for 3.8 through 3.11
• dependabot.yml: remove extra spaces

[main 88e0014] bump: version 0.4.0 → 0.5.0
2 files changed, 13 insertions(+), 2 deletions(-)

v0.4.0

v0.4.0 (2023-04-13)

BREAKING CHANGE

• users of the non-legacy API have to set html_theme to rocm_docs_theme to maintain the current behaviour.

Fix

• legacy: fix builds without doxygen
• extension: no longer set the html_theme by default in the extension
• legacy: restore custom theme on readthedocs

[main 6f275bb] bump: version 0.3.0 → 0.4.0
2 files changed, 14 insertions(+), 2 deletions(-)

v0.3.0

v0.3.0 (2023-04-13)

Feat

• move automatic doxygen and doxysphinx to an extension
• move core settings to a sphinx extension

Fix

• restore cookie permissions / analytics script

Refactor

• various formatting and type fixes in util.py

[main 046fcea] bump: version 0.2.2 → 0.3.0
2 files changed, 17 insertions(+), 2 deletions(-)

v0.2.2

v0.2.2 (2023-04-13)

Fix

• various stlysheet fixes

[main 1d7d2e5] bump: version 0.2.1 → 0.2.2
2 files changed, 8 insertions(+), 2 deletions(-)

v0.2.1

v0.2.1 (2023-04-13)

Fix

• update links in header and footer (#87)

v0.0.1 (2023-03-13)

[main 87049c1] bump: version 0.2.0 → 0.2.1
2 files changed, 9 insertions(+), 2 deletions(-)
create mode 100644 CHANGELOG.md

v0.0.1

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://RadeonOpenCompute/rocm-docs-core.git.
• 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.

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)