Skip to content

Commit 64646c5

Browse files
priya-sundaram-devpre-commit-ci[bot]cclauss
authored
docs: configure Sphinx directly and drop unmaintained sphinx-pyproject (#15129)
* docs: configure Sphinx directly and drop unmaintained sphinx-pyproject sphinx-pyproject has no releases supporting Python 3.14/3.15 and pins an old Sphinx, which blocks the docs build on newer interpreters. Move the [tool.sphinx-pyproject] config into a plain docs/conf.py (project name, version and authors single-sourced from pyproject.toml via stdlib tomllib), drop the sphinx-pyproject dependency, and depend on sphinx>=8.2 directly. Also bump beautifulsoup4>=4.15 and pandas>=2.3.3. No changes to uv.lock. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Christian Clauss <cclauss@me.com>
1 parent dd86a88 commit 64646c5

2 files changed

Lines changed: 103 additions & 88 deletions

File tree

docs/conf.py

Lines changed: 101 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,102 @@
1-
from sphinx_pyproject import SphinxConfig
1+
# Configuration file for the Sphinx documentation builder.
2+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
3+
#
4+
# Project metadata (name/version/authors) is single-sourced from pyproject.toml
5+
# so it never drifts from the packaging metadata.
6+
import tomllib
7+
from pathlib import Path
28

3-
project = SphinxConfig("../pyproject.toml", globalns=globals()).name
9+
_pyproject = tomllib.loads(
10+
(Path(__file__).parent.parent / "pyproject.toml").read_text(encoding="utf-8")
11+
)
12+
_project = _pyproject["project"]
13+
14+
project = _project["name"]
15+
author = ", ".join(a["name"] for a in _project.get("authors", []))
16+
release = version = _project["version"]
17+
copyright = "2014, TheAlgorithms" # noqa: A001 # Sphinx requires this exact name
18+
19+
extensions = [
20+
"autoapi.extension",
21+
"myst_parser",
22+
]
23+
24+
autoapi_dirs = [
25+
"audio_filters",
26+
"backtracking",
27+
"bit_manipulation",
28+
"blockchain",
29+
"boolean_algebra",
30+
"cellular_automata",
31+
"ciphers",
32+
"computer_vision",
33+
"conversions",
34+
"data_compression",
35+
"data_structures",
36+
"digital_image_processing",
37+
"divide_and_conquer",
38+
"dynamic_programming",
39+
"electronics",
40+
"file_transfer",
41+
"financial",
42+
"fractals",
43+
"fuzzy_logic",
44+
"genetic_algorithm",
45+
"geodesy",
46+
"geometry",
47+
"graphics",
48+
"graphs",
49+
"greedy_methods",
50+
"hashes",
51+
"knapsack",
52+
"linear_algebra",
53+
"linear_programming",
54+
"machine_learning",
55+
"maths",
56+
"matrix",
57+
"networking_flow",
58+
"neural_network",
59+
"other",
60+
"physics",
61+
"project_euler",
62+
"quantum",
63+
"scheduling",
64+
"searches",
65+
"sorts",
66+
"strings",
67+
"web_programming",
68+
]
69+
autoapi_member_order = "groupwise"
70+
71+
exclude_patterns = [
72+
".*/*",
73+
"docs/",
74+
]
75+
76+
html_theme = "alabaster"
77+
html_static_path = ["_static"]
78+
templates_path = ["_templates"]
79+
80+
source_suffix = {
81+
".rst": "restructuredtext",
82+
".md": "markdown",
83+
}
84+
85+
myst_enable_extensions = [
86+
"amsmath",
87+
"attrs_inline",
88+
"colon_fence",
89+
"deflist",
90+
"dollarmath",
91+
"fieldlist",
92+
"html_admonition",
93+
"html_image",
94+
"replacements",
95+
"smartquotes",
96+
"strikethrough",
97+
"substitution",
98+
"tasklist",
99+
]
100+
myst_fence_as_directive = [
101+
"include",
102+
]

pyproject.toml

Lines changed: 2 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,12 @@ dependencies = [
1919
"matplotlib>=3.9.3",
2020
"numpy>=2.1.3",
2121
"opencv-python>=4.10.0.84",
22-
"pandas>=2.2.3",
22+
"pandas>=2.3.3",
2323
"pillow>=11.3",
2424
"qiskit>=2",
2525
"rich>=13.9.4",
2626
"scikit-learn>=1.5.2",
2727
"scipy>=1.16.2",
28-
"sphinx-pyproject>=0.3",
2928
"statsmodels>=0.14.4",
3029
"sympy>=1.13.3",
3130
"tweepy>=4.14",
@@ -40,8 +39,8 @@ test = [
4039
]
4140
docs = [
4241
"myst-parser>=4",
42+
"sphinx>=8.2",
4343
"sphinx-autoapi>=3.4",
44-
"sphinx-pyproject>=0.3",
4544
]
4645
euler-validate = [
4746
"httpx>=0.28.1",
@@ -185,86 +184,3 @@ report.omit = [
185184
"project_euler/*",
186185
]
187186
report.sort = "Cover"
188-
189-
[tool.sphinx-pyproject]
190-
copyright = "2014, TheAlgorithms"
191-
autoapi_dirs = [
192-
"audio_filters",
193-
"backtracking",
194-
"bit_manipulation",
195-
"blockchain",
196-
"boolean_algebra",
197-
"cellular_automata",
198-
"ciphers",
199-
"computer_vision",
200-
"conversions",
201-
"data_compression",
202-
"data_structures",
203-
"digital_image_processing",
204-
"divide_and_conquer",
205-
"dynamic_programming",
206-
"electronics",
207-
"file_transfer",
208-
"financial",
209-
"fractals",
210-
"fuzzy_logic",
211-
"genetic_algorithm",
212-
"geodesy",
213-
"geometry",
214-
"graphics",
215-
"graphs",
216-
"greedy_methods",
217-
"hashes",
218-
"knapsack",
219-
"linear_algebra",
220-
"linear_programming",
221-
"machine_learning",
222-
"maths",
223-
"matrix",
224-
"networking_flow",
225-
"neural_network",
226-
"other",
227-
"physics",
228-
"project_euler",
229-
"quantum",
230-
"scheduling",
231-
"searches",
232-
"sorts",
233-
"strings",
234-
"web_programming",
235-
]
236-
autoapi_member_order = "groupwise"
237-
# autoapi_python_use_implicit_namespaces = true
238-
exclude_patterns = [
239-
".*/*",
240-
"docs/",
241-
]
242-
extensions = [
243-
"autoapi.extension",
244-
"myst_parser",
245-
]
246-
html_static_path = [ "_static" ]
247-
html_theme = "alabaster"
248-
myst_enable_extensions = [
249-
"amsmath",
250-
"attrs_inline",
251-
"colon_fence",
252-
"deflist",
253-
"dollarmath",
254-
"fieldlist",
255-
"html_admonition",
256-
"html_image",
257-
# "linkify",
258-
"replacements",
259-
"smartquotes",
260-
"strikethrough",
261-
"substitution",
262-
"tasklist",
263-
]
264-
myst_fence_as_directive = [
265-
"include",
266-
]
267-
templates_path = [ "_templates" ]
268-
source_suffix.".rst" = "restructuredtext"
269-
source_suffix.".md" = "markdown"
270-
# ".txt" = "markdown"

0 commit comments

Comments
 (0)