mirror of
https://github.com/NVIDIA/nvbench.git
synced 2026-04-20 14:58:54 +00:00
4d887a44e4
1. Fixed xrefs in docs/sphinx-combined/cpp_benchmarks.md, which is built on top of docs/benchmarks.md Added level-1 heading, and pushed existing headings one level down. 2. Added py_benchmarks.md to document benchmarking of Python scripts. 3. Rearranged entries in index.rst so that overview documents come before API enumeration.
105 lines
2.8 KiB
Python
105 lines
2.8 KiB
Python
import os
|
|
|
|
project = "NVBench API"
|
|
author = "NVIDIA Corporation"
|
|
|
|
extensions = [
|
|
"breathe",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.autosummary",
|
|
"myst_parser",
|
|
]
|
|
|
|
templates_path = ["_templates"]
|
|
exclude_patterns = ["_build", "_doxygen"]
|
|
|
|
autosummary_generate = True
|
|
autodoc_default_options = {"members": True, "undoc-members": True}
|
|
|
|
release = "0.2.0"
|
|
|
|
_here = os.path.abspath(os.path.dirname(__file__))
|
|
_doxygen_xml = os.path.join(_here, "_doxygen", "xml")
|
|
|
|
breathe_projects = {"nvbench": _doxygen_xml}
|
|
breathe_default_project = "nvbench"
|
|
breathe_domain_by_extension = {"cuh": "cpp", "cxx": "cpp", "cu": "cpp"}
|
|
|
|
|
|
def _patch_breathe_namespace_declarations() -> None:
|
|
try:
|
|
import breathe.renderer.sphinxrenderer as sphinxrenderer
|
|
from docutils import nodes
|
|
from sphinx import addnodes
|
|
except Exception:
|
|
return
|
|
|
|
original = sphinxrenderer.SphinxRenderer.handle_declaration
|
|
|
|
def handle_declaration(self, nodeDef, declaration, *args, **kwargs):
|
|
is_namespace = getattr(nodeDef, "kind", None) == "namespace"
|
|
if not is_namespace:
|
|
return original(self, nodeDef, declaration, *args, **kwargs)
|
|
|
|
name = (declaration or "").strip()
|
|
if name.startswith("namespace "):
|
|
name = name[len("namespace ") :].strip()
|
|
if not name:
|
|
name = "<anonymous>"
|
|
|
|
keyword = addnodes.desc_sig_keyword("namespace", "namespace")
|
|
sig_name = addnodes.desc_sig_name(name, name)
|
|
return [keyword, nodes.Text(" "), sig_name]
|
|
|
|
sphinxrenderer.SphinxRenderer.handle_declaration = handle_declaration
|
|
|
|
|
|
def setup(app):
|
|
_patch_breathe_namespace_declarations()
|
|
|
|
|
|
######################################################
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
html_theme = "nvidia_sphinx_theme"
|
|
|
|
html_logo = "_static/nvidia-logo.png"
|
|
|
|
html_baseurl = (
|
|
os.environ.get("NVBENCH_DOCS_BASE_URL", "https://nvidia.github.io/nvbench/").rstrip(
|
|
"/"
|
|
)
|
|
+ "/"
|
|
)
|
|
|
|
html_theme_options = {
|
|
"icon_links": [
|
|
{
|
|
"name": "GitHub",
|
|
"url": "https://github.com/NVIDIA/nvbench",
|
|
"icon": "fa-brands fa-github",
|
|
"type": "fontawesome",
|
|
}
|
|
],
|
|
"navigation_depth": 4,
|
|
"show_toc_level": 2,
|
|
"navbar_start": ["navbar-logo"],
|
|
"navbar_end": ["theme-switcher", "navbar-icon-links"],
|
|
"footer_start": ["copyright"],
|
|
"footer_end": ["sphinx-version"],
|
|
"sidebar_includehidden": True,
|
|
"collapse_navigation": False,
|
|
# "switcher": {
|
|
# "json_url": f"{html_baseurl}nv-versions.json",
|
|
# "version_match": release,
|
|
# },
|
|
}
|
|
|
|
html_static_path = ["_static"] if os.path.exists("_static") else []
|
|
|
|
# Images directory
|
|
if os.path.exists("img"):
|
|
html_static_path.append("img")
|