forked from NVIDIA/OpenShell
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathconf.py
More file actions
117 lines (101 loc) · 2.61 KB
/
conf.py
File metadata and controls
117 lines (101 loc) · 2.61 KB
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
import sys
from datetime import date
from pathlib import Path
sys.path.insert(0, str(Path(__file__).parent.parent))
sys.path.insert(0, str(Path(__file__).parent / "_ext"))
project = "NVIDIA OpenShell Developer Guide"
this_year = date.today().year
copyright = f"2025-{this_year}, NVIDIA Corporation"
author = "NVIDIA Corporation"
release = "latest"
extensions = [
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"sphinx.ext.intersphinx",
"sphinx_copybutton",
"sphinx_design",
"sphinxcontrib.mermaid",
"policy_table",
"json_output",
"search_assets",
]
autodoc_default_options = {
"members": True,
"undoc-members": False,
"show-inheritance": True,
"member-order": "bysource",
}
autodoc_typehints = "description"
autodoc_class_signature = "separated"
copybutton_exclude = ".linenos, .gp, .go"
exclude_patterns = [
"README.md",
"SETUP.md",
"CONTRIBUTING.md",
"_build/**",
"_ext/**",
]
myst_linkify_fuzzy_links = False
myst_heading_anchors = 4
myst_enable_extensions = [
"colon_fence",
"deflist",
"dollarmath",
"fieldlist",
"substitution",
]
myst_links_external_new_tab = True
myst_substitutions = {
"version": release,
}
templates_path = ["_templates"]
html_theme = "nvidia_sphinx_theme"
html_copy_source = False
html_show_sourcelink = False
html_show_sphinx = False
mermaid_init_js = (
"mermaid.initialize({"
" startOnLoad: true,"
" theme: 'base',"
" themeVariables: {"
" background: '#ffffff',"
" primaryColor: '#76b900',"
" primaryTextColor: '#000000',"
" primaryBorderColor: '#000000',"
" lineColor: '#000000',"
" textColor: '#000000',"
" mainBkg: '#ffffff',"
" nodeBorder: '#000000'"
" }"
"});"
)
html_domain_indices = False
html_use_index = False
html_extra_path = ["project.json"]
highlight_language = "console"
html_theme_options = {
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/NVIDIA/OpenShell",
"icon": "fa-brands fa-github",
"type": "fontawesome",
},
{
"name": "PyPI",
"url": "https://pypi.org/project/openshell/",
"icon": "fa-brands fa-python",
"type": "fontawesome",
},
],
}
html_baseurl = "https://docs.nvidia.com/openshell/latest/"
json_output_settings = {
"enabled": True,
"verbose": True,
}