mirror of
https://github.com/ROCm/composable_kernel.git
synced 2026-06-29 11:16:59 +00:00
01bad4c3d9
[Docs] Standardize precision support reference pages across components (#8205) ## Motivation The goal of this PR is to standardize the precision support reference page format across all components, while also reducing the maintenance of burden of having to manually update the YAML data file in https://rocm.docs.amd.com/en/latest/reference/precision-support.html ## Technical Details - Each component maintains its own YAML file which will be eventually used in https://rocm.docs.amd.com/en/latest/reference/precision-support.html - A new precision support reference page is introduced which will not override existing data type/precision support content; it will serve as the overview/summary that will be linked in the ROCm reference page ## Test Plan - Built locally, viewed each component manually ## Test Result <!-- Briefly summarize test outcomes. --> ## Submission Checklist - [x] Look over the contributing guidelines at https://github.com/ROCm/ROCm/blob/develop/CONTRIBUTING.md#pull-requests.
58 lines
1.6 KiB
Python
58 lines
1.6 KiB
Python
# Copyright (c) Advanced Micro Devices, Inc., or its affiliates.
|
|
# SPDX-License-Identifier: MIT
|
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
import re
|
|
|
|
from rocm_docs import ROCmDocs
|
|
|
|
html_theme_options = {"flavor": "list"}
|
|
|
|
with open("../CMakeLists.txt", encoding="utf-8") as f:
|
|
match = re.search(r".*set\(version ([0-9.]+)[^0-9.]+", f.read())
|
|
if not match:
|
|
raise ValueError("VERSION not found!")
|
|
version_number = match[1]
|
|
left_nav_title = f"Composable Kernel {version_number} Documentation"
|
|
|
|
# for PDF output on Read the Docs
|
|
project = "Composable Kernel Documentation"
|
|
author = "Advanced Micro Devices, Inc."
|
|
copyright = "Copyright (c) 2023 Advanced Micro Devices, Inc. All rights reserved."
|
|
version = version_number
|
|
release = version_number
|
|
|
|
external_toc_path = "./sphinx/_toc.yml"
|
|
|
|
docs_core = ROCmDocs(left_nav_title)
|
|
docs_core.setup()
|
|
|
|
external_projects_current_project = "composable_kernel"
|
|
|
|
mathjax3_config = {
|
|
"tex": {
|
|
"macros": {
|
|
"diag": "\\operatorname{diag}",
|
|
}
|
|
}
|
|
}
|
|
|
|
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
|
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|
|
|
|
extensions += [
|
|
"sphinxcontrib.mermaid",
|
|
"sphinxcontrib.bibtex",
|
|
]
|
|
|
|
mermaid_output_format = "raw"
|
|
bibtex_bibfiles = ["refs.bib"]
|
|
|
|
cpp_id_attributes = ["__global__", "__device__", "__host__"]
|
|
extensions = globals().get("extensions", []) + ["sphinxcontrib.datatemplates"]
|