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
162
163
164
165
|
from datetime import date
from warnings import filterwarnings
filterwarnings(
"ignore", message="Matplotlib is currently using agg", category=UserWarning
)
# General configuration
# ---------------------
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.addons.*') or your custom ones.
extensions = [
"sphinx.ext.autosummary",
"sphinx.ext.autodoc",
"sphinx.ext.imgmath",
"sphinx.ext.doctest",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx.ext.imgconverter",
"sphinx_gallery.gen_gallery",
"numpydoc",
]
# General substitutions.
project = "PyGraphviz"
copyright = f"2004-{date.today().year}, PyGraphviz Developers"
# Sphinx gallery configuration
sphinx_gallery_conf = {
"examples_dirs": "../../examples",
"gallery_dirs": "auto_examples",
"ignore_pattern": "skip_",
"image_scrapers": ("pygraphviz",),
}
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
#
# The short X.Y version.
import pygraphviz
version = pygraphviz.__version__
# The full version, including alpha/beta/rc tags.
release = version
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
add_module_names = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
# Options for HTML output
# -----------------------
html_baseurl = "https://pygraphviz.github.io/documentation/stable"
html_theme = "pydata_sphinx_theme"
html_theme_options = {
"navigation_depth": 3,
"icon_links": [
{
"name": "Home Page",
"url": "https://pygraphviz.github.io/",
"icon": "fas fa-home",
},
{
"name": "GitHub",
"url": "https://github.com/pygraphviz/pygraphviz",
"icon": "fab fa-github-square",
},
],
"logo": {
"text": "PyGraphviz",
},
"navbar_end": ["theme-switcher", "navbar-icon-links", "version-switcher"],
"show_prev_next": False,
"show_version_warning_banner": True,
"switcher": {
"json_url": (
"https://pygraphviz.github.io/documentation/latest/_static/version_switcher.json"
),
"version_match": "latest" if "dev" in version else version,
},
}
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
# html_style = 'sphinxdoc.css'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
html_last_updated_fmt = "%b %d, %Y"
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# Content template for the index page.
html_index = "contents.html"
# Custom sidebar templates, maps page names to templates.
# html_sidebars = {'index': 'indexsidebar.html'}
# Additional templates that should be rendered to pages, maps page names to
# templates.
# html_additional_pages = {'index': 'index.html'}
# If true, the reST sources are included in the HTML build as _sources/<name>.
html_copy_source = False
html_use_opensearch = "http://pygraphviz.github.io"
# Output file base name for HTML help builder.
htmlhelp_basename = "PyGraphviz"
pngmath_use_preview = True
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
latex_paper_size = "letter"
# The font size ('10pt', '11pt' or '12pt').
# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]).
latex_documents = [
(
"index",
"pygraphviz.tex",
"PyGraphviz Documentation",
"PyGraphviz Developers",
"manual",
1,
)
]
# latex_use_parts = True
# Additional stuff for the LaTeX preamble.
latex_elements = {"fontpkg": "\\usepackage{palatino}"}
# Documents to append as an appendix to all manuals.
# latex_appendices = []
|
