Skip to content

Commit cb23a7a

Browse files
authored
remove pandas API from the documentation (#1330)
* ignore the api generated files * use generated file in the API page * build the API everywhere it's needed * drop pandas api documentation * remove pandas related warnings * add autosummary parameters * build documentation in rdt * check warning in the static nox build * use autoapi instead of apidoc * fix: drop pandas page * fix: remove api page
1 parent 40a3032 commit cb23a7a

File tree

12 files changed

+57
-1482
lines changed

12 files changed

+57
-1482
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ instance/
6060
# Sphinx documentation
6161
docs/_build/
6262
docs/examples/generated/
63+
docs/api/
6364
warnings.txt
6465

6566
# PyBuilder

docs/conf.py

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,15 @@
2525
# -- General configuration ---------------------------------------------------
2626

2727
extensions = [
28+
"sphinx.ext.napoleon",
2829
"sphinx.ext.autodoc",
2930
"sphinx.ext.autosummary",
3031
"sphinx.ext.todo",
3132
"sphinx.ext.viewcode",
3233
"sphinxext.rediraffe",
3334
"sphinx_design",
3435
"sphinx_copybutton",
36+
"autoapi.extension",
3537
"_extension.gallery_directive",
3638
# For extension examples and demos
3739
"ablog",
@@ -64,11 +66,6 @@
6466
sitemap_locales = [None]
6567
sitemap_url_scheme = "{link}"
6668

67-
68-
# -- autosummary -------------------------------------------------------------
69-
70-
autosummary_generate = True
71-
7269
# -- Internationalization ----------------------------------------------------
7370

7471
# specifying the natural language populates some key tags
@@ -243,6 +240,18 @@
243240
{"name": "msapplication-TileImage", "content": "mstile-150x150.png"},
244241
]
245242

243+
# -- Options for autosummary/autodoc output ------------------------------------
244+
autosummary_generate = True
245+
autodoc_typehints = "description"
246+
autodoc_member_order = "groupwise"
247+
248+
# -- Options for autoapi -------------------------------------------------------
249+
autoapi_type = "python"
250+
autoapi_dirs = ["../src/pydata_sphinx_theme"]
251+
autoapi_keep_files = True
252+
autoapi_root = "api"
253+
autoapi_member_order = "groupwise"
254+
246255
# -- application setup -------------------------------------------------------
247256

248257

docs/examples/api.rst

Lines changed: 0 additions & 161 deletions
This file was deleted.

0 commit comments

Comments
 (0)