Skip to content

docs: configure Sphinx directly and drop unmaintained sphinx-pyproject #15123

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
priya-sundaram-dev wants to merge 1 commit into from
Closed

docs: configure Sphinx directly and drop unmaintained sphinx-pyproject #15123

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 110 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,111 @@
from sphinx_pyproject import SphinxConfig
"""Sphinx configuration for TheAlgorithms/Python.

project = SphinxConfig("../pyproject.toml", globalns=globals()).name
Migrated off ``sphinx-pyproject`` (unmaintained, no Python 3.14/3.15 support)
to a plain Sphinx ``conf.py``. Project metadata (name/version/author) is still
single-sourced from ``pyproject.toml`` via the stdlib ``tomllib`` parser; the
rest of the options that used to live under ``[tool.sphinx-pyproject]`` are
inlined below.
"""

import tomllib
from pathlib import Path

_pyproject_path = Path(__file__).parent.parent / "pyproject.toml"
_project = tomllib.loads(_pyproject_path.read_text())["project"]

# -- Project information -----------------------------------------------------
project = _project["name"]
version = release = _project["version"]
author = ", ".join(a["name"] for a in _project.get("authors", []) if "name" in a)
copyright = "2014, TheAlgorithms" # noqa: A001

# -- General configuration ---------------------------------------------------
extensions = [
"autoapi.extension",
"myst_parser",
]

templates_path = ["_templates"]
exclude_patterns = [
".*/*",
"docs/",
]

source_suffix = {
".rst": "restructuredtext",
".md": "markdown",
}

# -- autoapi (source tree -> API docs) ---------------------------------------
autoapi_dirs = [
"audio_filters",
"backtracking",
"bit_manipulation",
"blockchain",
"boolean_algebra",
"cellular_automata",
"ciphers",
"computer_vision",
"conversions",
"data_compression",
"data_structures",
"digital_image_processing",
"divide_and_conquer",
"dynamic_programming",
"electronics",
"file_transfer",
"financial",
"fractals",
"fuzzy_logic",
"genetic_algorithm",
"geodesy",
"geometry",
"graphics",
"graphs",
"greedy_methods",
"hashes",
"knapsack",
"linear_algebra",
"linear_programming",
"machine_learning",
"maths",
"matrix",
"networking_flow",
"neural_network",
"other",
"physics",
"project_euler",
"quantum",
"scheduling",
"searches",
"sorts",
"strings",
"web_programming",
]
autoapi_member_order = "groupwise"
# autoapi_python_use_implicit_namespaces = True

# -- MyST (Markdown) ---------------------------------------------------------
myst_enable_extensions = [
"amsmath",
"attrs_inline",
"colon_fence",
"deflist",
"dollarmath",
"fieldlist",
"html_admonition",
"html_image",
# "linkify",
"replacements",
"smartquotes",
"strikethrough",
"substitution",
"tasklist",
]
myst_fence_as_directive = [
"include",
]

# -- HTML output -------------------------------------------------------------
html_theme = "alabaster"
html_static_path = ["_static"]
86 changes: 1 addition & 85 deletions pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ dependencies = [
"rich>=13.9.4",
"scikit-learn>=1.5.2",
"scipy>=1.16.2",
"sphinx-pyproject>=0.3",
"statsmodels>=0.14.4",
"sympy>=1.13.3",
"tweepy>=4.14",
Expand All @@ -40,8 +39,8 @@ test = [
]
docs = [
"myst-parser>=4",
"sphinx>=8.2",
"sphinx-autoapi>=3.4",
"sphinx-pyproject>=0.3",
]
euler-validate = [
"httpx>=0.28.1",
Expand Down Expand Up @@ -185,86 +184,3 @@ report.omit = [
"project_euler/*",
]
report.sort = "Cover"

[tool.sphinx-pyproject]
copyright = "2014, TheAlgorithms"
autoapi_dirs = [
"audio_filters",
"backtracking",
"bit_manipulation",
"blockchain",
"boolean_algebra",
"cellular_automata",
"ciphers",
"computer_vision",
"conversions",
"data_compression",
"data_structures",
"digital_image_processing",
"divide_and_conquer",
"dynamic_programming",
"electronics",
"file_transfer",
"financial",
"fractals",
"fuzzy_logic",
"genetic_algorithm",
"geodesy",
"geometry",
"graphics",
"graphs",
"greedy_methods",
"hashes",
"knapsack",
"linear_algebra",
"linear_programming",
"machine_learning",
"maths",
"matrix",
"networking_flow",
"neural_network",
"other",
"physics",
"project_euler",
"quantum",
"scheduling",
"searches",
"sorts",
"strings",
"web_programming",
]
autoapi_member_order = "groupwise"
# autoapi_python_use_implicit_namespaces = true
exclude_patterns = [
".*/*",
"docs/",
]
extensions = [
"autoapi.extension",
"myst_parser",
]
html_static_path = [ "_static" ]
html_theme = "alabaster"
myst_enable_extensions = [
"amsmath",
"attrs_inline",
"colon_fence",
"deflist",
"dollarmath",
"fieldlist",
"html_admonition",
"html_image",
# "linkify",
"replacements",
"smartquotes",
"strikethrough",
"substitution",
"tasklist",
]
myst_fence_as_directive = [
"include",
]
templates_path = [ "_templates" ]
source_suffix.".rst" = "restructuredtext"
source_suffix.".md" = "markdown"
# ".txt" = "markdown"
Loading