diff --git a/docs/conf.py b/docs/conf.py index 718797ac..3173fabc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,29 +28,30 @@ import re -from rocm_docs import ROCmDocs - with open("../VERSION", encoding="utf-8") as f: match = re.search(r"([0-9.]+)[^0-9.]+", f.read()) if not match: raise ValueError("VERSION not found!") version_number = match[1] -external_projects_current_project = "omnitrace" - -project = "omnitrace" +# project info +project = "Omnitrace" author = "Advanced Micro Devices, Inc." copyright = "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved." version = version_number release = version_number -html_title = f"Omnitrace {version} documentation" -external_toc_path = "./sphinx/_toc.yml" +extensions = ["rocm_docs", "rocm_docs.doxygen", "sphinxcontrib.datatemplates"] +html_theme = "rocm_docs_theme" +html_theme_options = {"flavor": "rocm"} +html_title = f"Omnitrace {version_number} documentation" -docs_core = ROCmDocs(html_title) -docs_core.setup() -docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml") -docs_core.enable_api_reference() +external_toc_path = "./sphinx/_toc.yml" +external_projects_current_project = "omnitrace" -for sphinx_var in ROCmDocs.SPHINX_VARS: - globals()[sphinx_var] = getattr(docs_core, sphinx_var) +doxygen_root = "doxygen" +doxysphinx_enabled = True +doxygen_project = { + "name": "Omnitrace API", + "path": "doxygen/xml", +} diff --git a/docs/install/install.rst b/docs/install/install.rst index 8973e5ed..34645ae7 100644 --- a/docs/install/install.rst +++ b/docs/install/install.rst @@ -69,45 +69,47 @@ might be more portable. Installing Omnitrace from binary distributions ================================================ -Every Omnitrace release provides binary installer scripts of the form: +.. datatemplate:nodata:: -.. code-block:: shell + Every Omnitrace release provides binary installer scripts of the form: - omnitrace-{VERSION}-{OS_DISTRIB}-{OS_VERSION}[-ROCm-{ROCM_VERSION}[-{EXTRA}]].sh + .. code-block:: shell -For example, + omnitrace-{{ config.version }}-{OS_DISTRIB}-{OS_VERSION}[-ROCm-{ROCM_VERSION}[-{EXTRA}]].sh -.. code-block:: shell + For example, - omnitrace-1.0.0-ubuntu-18.04-OMPT-PAPI-Python3.sh - omnitrace-1.0.0-ubuntu-18.04-ROCm-405000-OMPT-PAPI-Python3.sh - ... - omnitrace-1.0.0-ubuntu-20.04-ROCm-50000-OMPT-PAPI-Python3.sh + .. code-block:: shell -Any of the ``EXTRA`` fields with a CMake build option -(for example, PAPI, as referenced in a following section) or -with no link requirements (such as OMPT) have -self-contained support for these packages. + omnitrace-{{ config.version }}-ubuntu-18.04-OMPT-PAPI-Python3.sh + omnitrace-{{ config.version }}-ubuntu-18.04-ROCm-405000-OMPT-PAPI-Python3.sh + ... + omnitrace-{{ config.version }}-ubuntu-20.04-ROCm-50000-OMPT-PAPI-Python3.sh -To install Omnitrace using a binary installer script, follow these steps: + Any of the ``EXTRA`` fields with a CMake build option + (for example, PAPI, as referenced in a following section) or + with no link requirements (such as OMPT) have + self-contained support for these packages. -#. Download the appropriate binary distribution + To install Omnitrace using a binary installer script, follow these steps: - .. code-block:: shell + #. Download the appropriate binary distribution - wget https://github.com/ROCm/omnitrace/releases/download/v/