File: conf.py

package info (click to toggle)
rocr-runtime 6.1.2-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 6,528 kB
  • sloc: cpp: 81,527; ansic: 4,499; asm: 601; lisp: 599; sh: 123; python: 23; makefile: 12
file content (38 lines) | stat: -rw-r--r-- 1,217 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# 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 os
import re

from rocm_docs import ROCmDocs

os.system("cp ../README.md index.md")
os.system("cp ../src/README.md structure.md")

with open('../src/CMakeLists.txt', encoding='utf-8') as f:
    match = re.search(r'get_version \(\s+\"?([0-9.]+)[^0-9.]+', f.read())
    if not match:
        raise ValueError("VERSION not found!")
    version_number = match[1]
left_nav_title = f"ROCR {version_number} Documentation"

# for PDF output on Read the Docs
project = "ROCR Documentation"
author = "Advanced Micro Devices, Inc."
copyright = "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved."
version = version_number
release = version_number

external_toc_path = "./sphinx/_toc.yml"

external_projects_current_project = "rocr-runtime"

docs_core = ROCmDocs(left_nav_title)
docs_core.run_doxygen(doxygen_root="doxygen", doxygen_path="doxygen/xml")
docs_core.setup()

for sphinx_var in ROCmDocs.SPHINX_VARS:
    globals()[sphinx_var] = getattr(docs_core, sphinx_var)