Kiss, Istvan
d0cf32a63a
* Update docs 2025 03 31 - Docs: remove virtual_rocr.rst - Fix documentation warnings - Reformat HIP RTC - Docs: Refactor HIP porting guide - Docs: Expand HIP porting guide and CUDA driver porting guide - Minor fix - Docs: Update environment variables file - Bump rocm-docs-core[api_reference] from 1.15.0 to 1.17.0 in /docs/sphinx - Docs: Update FP8 page to show both FP8 and FP16 types - Bump sphinxcontrib-doxylink from 1.12.4 to 1.13.0 in /docs/sphinx - Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core) from 1.17.0 to 1.17.1. - Remove external link - Update programming model - Bump rocm-docs-core[api_reference] from 1.17.1 to 1.18.1 in /docs/sphinx - Docs: Add page for Complex Math API - Docs: Add page about HIP error codes - Update docs: the compilation cache is enabled by default - Fix fns32 function mask type in doc * Bump rocm-docs-core[api_reference] from 1.18.1 to 1.18.2 in /docs/sphinx Bumps [rocm-docs-core[api_reference]](https://github.com/ROCm/rocm-docs-core) from 1.18.1 to 1.18.2. - [Release notes](https://github.com/ROCm/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/develop/CHANGELOG.md) - [Commits](https://github.com/ROCm/rocm-docs-core/compare/v1.18.1...v1.18.2) --- updated-dependencies: - dependency-name: rocm-docs-core[api_reference] dependency-version: 1.18.2 dependency-type: direct:production update-type: version-update:semver-patch * Fix readme link * Docs: Fix verbose paths generated by doxygen * Handle git ssh in docs conf.py
65 rindas
1.9 KiB
Python
65 rindas
1.9 KiB
Python
# 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
|
|
import sys
|
|
import subprocess
|
|
from pathlib import Path
|
|
from typing import Any, Dict, List
|
|
|
|
from rocm_docs import ROCmDocs
|
|
|
|
version_numbers = []
|
|
version_file = open("../VERSION", "r")
|
|
lines = version_file.readlines()
|
|
for line in lines:
|
|
if line[0] == '#':
|
|
continue
|
|
version_numbers.append(line.strip())
|
|
version_number = ".".join(version_numbers)
|
|
left_nav_title = f"HIP {version_number} Documentation"
|
|
|
|
# for PDF output on Read the Docs
|
|
project = "HIP 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.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
|
|
docs_core.enable_api_reference()
|
|
docs_core.setup()
|
|
|
|
external_projects_current_project = "hip"
|
|
|
|
for sphinx_var in ROCmDocs.SPHINX_VARS:
|
|
globals()[sphinx_var] = getattr(docs_core, sphinx_var)
|
|
|
|
# Add the _extensions directory to Python's search path
|
|
sys.path.append(str(Path(__file__).parent / 'extension'))
|
|
|
|
extensions += ["sphinxcontrib.doxylink", "custom_directive"]
|
|
|
|
cpp_id_attributes = ["__global__", "__device__", "__host__", "__forceinline__", "static"]
|
|
cpp_paren_attributes = ["__declspec"]
|
|
|
|
suppress_warnings = ["etoc.toctree"]
|
|
|
|
numfig = False
|
|
|
|
exclude_patterns = [
|
|
"doxygen/mainpage.md",
|
|
"understand/glossary.md",
|
|
'how-to/debugging_env.rst',
|
|
"data/env_variables_hip.rst"
|
|
]
|
|
|
|
git_url = subprocess.check_output(['git', 'config', '--get', 'remote.origin.url']).strip().decode('ascii')
|
|
if git_url.find("git:") != -1:
|
|
html_theme_options = {"repository_url": "https://github.com/ROCm/hip"} |