/
conf.py
149 lines (124 loc) · 4.81 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
# Configuration file for the Sphinx documentation builder.
#
# Full list of options can be found in the Sphinx documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import os
import sys
from typing import Any, Dict
# add the demo python code to the path, so that it can be used to demonstrate
# source links
sys.path.append(os.path.abspath("./kitchen-sink/demo_py"))
# -- Project information -----------------------------------------------------
#
project = "furo"
copyright = "2020, Pradyun Gedam"
author = "Pradyun Gedam"
# -- General configuration ---------------------------------------------------
#
extensions = [
# Sphinx's own extensions
"sphinx.ext.autodoc",
"sphinx.ext.extlinks",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
# Our custom extension, only meant for Furo's own documentation.
"furo.sphinxext",
# External stuff
"myst_parser",
"sphinx_copybutton",
"sphinx_design",
"sphinx_inline_tabs",
]
# -- Options for extlinks ----------------------------------------------------
#
extlinks = {
"pypi": ("https://pypi.org/project/%s/", "%s"),
}
# -- Options for intersphinx -------------------------------------------------
#
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"sphinx": ("https://www.sphinx-doc.org/en/master", None),
}
# -- Options for TODOs -------------------------------------------------------
#
todo_include_todos = True
# -- Options for Markdown files ----------------------------------------------
#
myst_enable_extensions = [
"colon_fence",
"deflist",
]
myst_heading_anchors = 3
# -- Options for HTML output -------------------------------------------------
#
html_theme = "furo"
html_title = "Furo"
language = "en"
html_static_path = ["_static"]
html_css_files = ["pied-piper-admonition.css"]
html_theme_options: Dict[str, Any] = {
"footer_icons": [
{
"name": "GitHub",
"url": "https://github.com/pradyunsg/furo",
"html": """
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
</svg>
""",
"class": "",
},
],
"source_repository": "https://github.com/pradyunsg/furo/",
"source_branch": "main",
"source_directory": "docs/",
}
if "READTHEDOCS" in os.environ:
html_theme_options["announcement"] = (
"This documentation is hosted on Read the Docs only for testing. Please use "
"<a href='https://pradyunsg.me/furo/'>the main documentation</a> instead."
)
# -- Options for theme development -------------------------------------------
# Make sure these are all set to the default values.
html_js_files = []
html_context: Dict[str, Any] = {}
# html_show_sphinx = False
# html_show_copyright = False
# html_last_updated_fmt = ""
RTD_TESTING = False
if RTD_TESTING or "FURO_RTD_TESTING" in os.environ:
del html_theme_options["footer_icons"]
html_css_files += [
"https://assets.readthedocs.org/static/css/readthedocs-doc-embed.css",
"https://assets.readthedocs.org/static/css/badge_only.css",
]
html_js_files += [
"readthedocs-dummy.js",
"https://assets.readthedocs.org/static/javascript/readthedocs-doc-embed.js",
]
html_context["READTHEDOCS"] = True
html_context["current_version"] = "latest"
html_context["conf_py_path"] = "/docs/"
html_context["display_github"] = True
html_context["github_user"] = "pradyunsg"
html_context["github_repo"] = "furo"
html_context["github_version"] = "main"
html_context["slug"] = "furo"
FONT_AWESOME_TESTING = False
if FONT_AWESOME_TESTING:
html_css_files += [
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css",
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css",
"https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css",
]
html_theme_options["footer_icons"] = [
{
"name": "GitHub",
"url": "https://github.com/pradyunsg/furo",
"html": "",
"class": "fa-solid fa-github fa-2x",
},
]