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
|
[build-system]
requires = ["setuptools>=42", "wheel"]
[tool.setuptools.dynamic]
version = {attr = "pydata_sphinx_theme.__version__"}
[tool.sphinx-theme-builder]
node-version = "22.9.0"
theme-name = "pydata_sphinx_theme"
additional-compiled-static-assets = [
"webpack-macros.html",
"vendor/",
"scripts/bootstrap.js",
"scripts/fontawesome.js",
"locale/",
]
[project]
name = "pydata-sphinx-theme"
description = "Bootstrap-based Sphinx theme from the PyData community"
dynamic = ["version"]
readme = "README.md"
requires-python = ">=3.9"
dependencies = [
"sphinx>=6.1",
"beautifulsoup4",
"docutils!=0.17.0",
"Babel",
"pygments>=2.7",
"accessible-pygments",
"typing-extensions",
]
license = { file = "LICENSE" }
maintainers = [
{ name = "Joris Van den Bossche", email = "jorisvandenbossche@gmail.com" },
]
classifiers = [
"Development Status :: 5 - Production/Stable",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Framework :: Sphinx",
"Framework :: Sphinx :: Theme",
"License :: OSI Approved :: BSD License",
"Operating System :: OS Independent",
]
[project.urls]
"Source" = "https://github.com/pydata/pydata-sphinx-theme"
[project.optional-dependencies]
doc = [
"numpydoc",
"linkify-it-py", # for link shortening
"rich",
"sphinxext-rediraffe",
"sphinx-sitemap",
"sphinx-autoapi>=3.0.0",
# For examples section
"myst-parser",
"ablog>=0.11.8",
"jupyter_sphinx",
"pandas",
"plotly",
"matplotlib",
"numpy",
"xarray",
"sphinx-copybutton",
"sphinx-design",
"sphinx-togglebutton",
"jupyterlite-sphinx",
"sphinxcontrib-youtube>=1.4.1",
"sphinx-favicon>=1.0.1",
"ipykernel",
"nbsphinx",
"ipyleaflet",
"colorama",
"ipywidgets",
"graphviz",
]
test = ["pytest", "pytest-cov", "pytest-regressions", "sphinx[test]"]
dev = [
"pyyaml",
"pre-commit",
"pydata-sphinx-theme[doc,test]",
"tox",
"pandoc",
"sphinx-theme-builder[cli]",
]
a11y = ["pytest-playwright"]
i18n = ["Babel", "jinja2"]
[project.entry-points]
"sphinx.html_themes" = { pydata_sphinx_theme = "pydata_sphinx_theme" }
[tool.doc8]
ignore = ["D001"] # we follow a 1 line = 1 paragraph style
[tool.ruff]
fix = true
# keep consistent with black
line-length = 88
indent-width = 4
[tool.ruff.lint]
ignore = [
"D107", # Missing docstring in `__init__` | set the docstring in the class
"D205", # 1 blank line required between summary line and description,
"D212", # docstring summary must be on first physical line
"W291", # let pre-commit handle trailing whitespace
]
select = ["E", "F", "W", "I", "D", "RUF", "G"]
[tool.ruff.lint.flake8-quotes]
docstring-quotes = "double"
[tool.ruff.lint.pydocstyle]
convention = "google"
[tool.ruff.lint.isort]
lines-between-types = 1
lines-after-imports = 2
[tool.djlint]
profile = "jinja"
extension = "html"
indent = 2
max_line_length = 120
use_gitignore = true
format_js = true
format_css = true
ignore = "H006,J018,T003,H025"
[tool.pytest.ini_options]
markers = "a11y: mark a test as an accessibility test"
[tool.coverage.run]
source = ["pydata_sphinx_theme"]
branch = true
relative_files = true
[tool.coverage.report]
fail_under = 80
show_missing = true
skip_covered = true
[tool.coverage.paths]
source = ["src", ".tox/py*/**/site-packages"]
|
