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
|
# 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
def get_version(filename):
import re
with open(filename) as fd:
data = fd.read()
mobj = re.search(
r"""^__version__\s*=\s*(?P<quote>['"])(?P<version>.*)(?P=quote)""",
data,
re.MULTILINE,
)
return mobj.group("version")
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
project = "PyTables"
copyright = "2011–2025, PyTables maintainers" # noqa: A001
author = "PyTables maintainers"
version = get_version("../../tables/_version.py")
release = version
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
needs_sphinx = "1.3"
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.doctest",
"sphinx.ext.mathjax",
"sphinx.ext.inheritance_diagram",
"sphinx.ext.extlinks",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
# 'numpydoc',
"sphinx_rtd_theme",
"IPython.sphinxext.ipython_console_highlighting",
]
templates_path = ["_templates"]
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]
html_theme_options = {
# 'sticky_navigation': True # Set to False to disable the sticky nav while scrolling.
"logo_only": True, # if we have a html_logo below, this shows /only/ the logo with no title text
}
html_logo = "_static/logo-pytables-small.png"
# -- Options for HTMLHelp output ---------------------------------------------
htmlhelp_basename = "PyTablesDoc"
# -- Options for LaTeX output ------------------------------------------------
latex_elements = {
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',
# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',
# Additional stuff for the LaTeX preamble.
"preamble": r"""\usepackage{bookmark,hyperref}
\usepackage[para]{threeparttable}
\DeclareUnicodeCharacter{210F}{$\hbar$}""",
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
}
latex_documents = [
(
"usersguide/usersguide",
f"usersguide-{version}.tex",
"PyTables User Guide",
"PyTables maintainers",
"manual",
),
]
latex_logo = "usersguide/images/pytables-front-logo.pdf"
latex_use_parts = True
latex_domain_indices = False
# -- Options for Epub output -------------------------------------------------
# Bibliographic Dublin Core info.
epub_title = project
epub_author = author
epub_publisher = author
epub_copyright = copyright
epub_exclude_files = ["search.html"]
# -- Extension configuration -------------------------------------------------
# -- Options for intersphinx extension ---------------------------------------
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"https://docs.python.org/": None}
# -- External link options ----------------------------------------------------
extlinks = {
"issue": ("https://github.com/PyTables/PyTables/issues/%s", "gh-%s"),
"PR": ("https://github.com/PyTables/PyTables/pull/%s", "gh-%s"),
"commit": ("https://github.com/PyTables/PyTables/commit/%s", "commit %s"),
}
# -- Options for autodocumentation ---------------------------------------------
autodoc_member_order = "groupwise"
autoclass_content = "class"
autosummary_generate = []
# -- Options for mathjax -----------------------------------------------------
mathjax_path='file:///usr/share/javascript/mathjax/MathJax.js'
|
