Skip to content

Commit ffa489d

Browse files
committed
docs: replace sphinxcontrib.apidoc with built-in
Use the built-in `sphinx.ext.apidoc` extension instead of `sphinxcontrib.apidoc`, which has been deprecated: sphinx-contrib/apidoc@8321984 sphinx-contrib/apidoc@f5f1ec8 Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
1 parent f9182d2 commit ffa489d

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

docs/conf.py

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@
6060
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
6161
# ones.
6262
extensions = [
63+
'sphinx.ext.apidoc',
6364
'sphinx.ext.autodoc',
6465
'sphinx.ext.doctest',
6566
'sphinx.ext.intersphinx',
6667
'sphinx.ext.todo',
6768
'sphinx.ext.viewcode',
6869
'sphinx.ext.githubpages',
6970
'sphinxarg.ext',
70-
'sphinxcontrib.apidoc',
7171
]
7272

7373
# Add any paths that contain templates here, relative to this directory.
@@ -214,7 +214,12 @@
214214

215215
# -- Options for apidoc extension --------------------------------------------
216216

217-
apidoc_module_dir = '../src/packagename'
217+
apidoc_modules = [
218+
{
219+
'path': '../src/packagename',
220+
'destination': 'api',
221+
},
222+
]
218223

219224
# -- Options for intersphinx extension ---------------------------------------
220225

pyproject.toml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,8 @@ lint = [
5959
]
6060
docs = [
6161
# Abstract top-level documentation generator dependencies
62-
'Sphinx',
62+
'Sphinx >= 8.2.0',
6363
'sphinx-argparse',
64-
'sphinxcontrib-apidoc',
6564
]
6665
test = [
6766
# Abstract top-level dependencies for running tests

0 commit comments

Comments
 (0)