Skip to content

Commit ef1cf3a

Browse files
committed
simplify doc config
1 parent 25a1bab commit ef1cf3a

File tree

2 files changed

+13
-35
lines changed

2 files changed

+13
-35
lines changed

docs/source/conf.py

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,3 @@
1-
import sys
1+
from sphinx_pyproject import SphinxConfig
22

3-
from pathlib import Path
4-
5-
top_path = Path('..', '..').resolve()
6-
sys.path.insert(0, str(top_path))
7-
8-
# Configuration file for the Sphinx documentation builder.
9-
#
10-
# For the full list of built-in configuration values, see the documentation:
11-
# https://www.sphinx-doc.org/en/master/usage/configuration.html
12-
13-
# -- Project information -----------------------------------------------------
14-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
15-
16-
project = 'fpy2'
17-
copyright = '2025, Brett Saiki'
18-
author = 'Brett Saiki'
19-
release = '0.1.1'
20-
21-
# -- General configuration ---------------------------------------------------
22-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
23-
24-
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon']
25-
26-
templates_path = ['_templates']
27-
exclude_patterns = []
28-
29-
30-
31-
# -- Options for HTML output -------------------------------------------------
32-
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
33-
34-
html_theme = 'sphinx_rtd_theme'
35-
html_static_path = ['_static']
3+
config = SphinxConfig('../../pyproject.toml', globalns=globals())

pyproject.toml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ dev = [
3030
"build",
3131
"twine",
3232
"sphinx",
33-
"sphinx-rtd-theme"
33+
"sphinx-rtd-theme",
34+
"sphinx-pyproject"
3435
]
3536

3637
[project.urls]
@@ -48,3 +49,12 @@ check_untyped_defs = true
4849
[tool.ruff.lint]
4950
extend-select = ["B"]
5051
ignore = ["F401", "F403", "F405", "B905"]
52+
53+
[tool.sphinx-pyproject]
54+
project = "fpy2"
55+
author = "Brett Saiki"
56+
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon']
57+
templates_path = ['_templates']
58+
exclude_patterns = []
59+
html_theme = 'sphinx_rtd_theme'
60+
html_static_path = ['_static']

0 commit comments

Comments
 (0)