-
Notifications
You must be signed in to change notification settings - Fork 8
/
conf.py
161 lines (141 loc) · 5.25 KB
/
conf.py
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
import os
import subprocess
os.chdir(os.path.dirname(os.path.abspath(__file__)))
# Clone the DIPs repository and process DIPs so they are rendered properly
if not os.path.exists('_external_repo'):
subprocess.check_call(['git', 'clone', 'https://github.com/dashpay/dips.git', '_dips'])
subprocess.check_call(['./scripts/dip-format.sh'])
subprocess.check_call('cd _dips/ && find . -name ".git" -prune -o -print -exec cp --parents \{} ../docs/dips/ \;', shell=True)
subprocess.check_call('cd', shell=True)
subprocess.check_call('rm -rf _dips/', shell=True)
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = 'Dash Core'
copyright = '2024, Dash Core Group, Inc'
author = 'thephez'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = u'latest'
# The full version, including alpha/beta/rc tags.
release = u'latest'
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
extensions = [
'hoverxref.extension',
'myst_parser',
'sphinx.ext.autodoc',
'sphinx_copybutton',
'sphinx_design',
'sphinx.ext.intersphinx',
]
templates_path = ['_templates']
exclude_patterns = [
'_build',
'_dips',
'Thumbs.db',
'.DS_Store',
'README.md',
'.devcontainer',
'scripts',
'img/dev/gifs/README.md',
'docs/api/ai-prompt.md',
]
# The master toctree document.
master_doc = 'index'
hoverxref_role_types = {
'hoverxref': 'tooltip',
}
# -- Myst parser configuration -----------------------------------------------
# Auto-generate header anchors for md headings
myst_heading_anchors = 5
# Enable colon_fence for better markdown compatibility
# https://myst.tools/docs/mystjs/syntax-overview#directives
myst_enable_extensions = ["colon_fence"]
# -- intersphinx configuration -----------------------------------------------
intersphinx_mapping = {
"user": ("https://docs.dash.org/en/stable/", None),
"platform": ("https://docs.dash.org/projects/platform/en/stable/", None),
}
# We recommend adding the following config value.
# Sphinx defaults to automatically resolve *unresolved* labels using all your Intersphinx mappings.
# This behavior has unintended side-effects, namely that documentations local references can
# suddenly resolve to an external location.
# See also:
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes
intersphinx_disabled_reftypes = ["*"]
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "pydata_sphinx_theme"
html_static_path = ['_static']
html_logo = 'img/dash_logo.png'
html_css_files = [
'css/footer.css',
'css/pydata-overrides.css',
]
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
html_sidebars = {
"index": ["sidebar-main.html"],
"**": ["sidebar-nav-bs"]
}
html_theme_options = {
# "announcement": "Test build of Dash Core documentation migrated from <a href='https://dashcore.readme.io'>Readme.io</a>!",
"external_links": [
{"name": "Platform docs", "url": "https://docs.dash.org/projects/platform/en/stable/docs/index.html"},
{"name": "User docs", "url": "https://docs.dash.org/"},
{"name": "Dash.org", "url": "https://www.dash.org"},
{"name": "Forum", "url": "https://www.dash.org/forum"},
],
"use_edit_page_button": True,
"github_url": "https://github.com/dashpay/docs-core",
"show_toc_level": 2,
"show_nav_level": 1,
"favicons": [
{
"rel": "icon",
"sizes": "16x16",
"href": "img/favicon-16x16.png",
},
{
"rel": "icon",
"sizes": "32x32",
"href": "img/favicon-32x32.png",
},
{
"rel": "icon",
"sizes": "96x96",
"href": "img/favicon-96x96.png",
},
{
"rel": "icon",
"sizes": "144x144",
"href": "img/favicon-144x144.png",
},
],
"footer_start": ["copyright"],
"footer_center": ["sphinx-version"],
"footer_end": ["theme-version"],
# "navbar_start": ["navbar-logo", "languages"],
# "navbar_center": ["languages", "navbar-nav", "languages"],
# "navbar_end": ["navbar-icon-links", "version"],
# "secondary_sidebar_items": ["languages", "page-toc", "edit-this-page", "sourcelink"],
# "footer_items": ["languages", "copyright", "sphinx-version", "theme-version"],
# "primary_sidebar_end": ["languages"],
}
html_context = {
# "github_url": "https://github.com", # or your GitHub Enterprise site
"github_user": "dashpay",
"github_repo": "docs-core",
"github_version": "21.0.0",
"doc_path": "",
}
def setup(app):
app.add_js_file('js/pydata-search-close.js')