Skip to content

Commit

Permalink
remove pandas API from the documentation (#1330)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
12rambau committed Jun 20, 2023
1 parent 40a3032 commit cb23a7a
Show file tree
Hide file tree
Showing 12 changed files with 57 additions and 1,482 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ instance/
# Sphinx documentation
docs/_build/
docs/examples/generated/
docs/api/
warnings.txt

# PyBuilder
Expand Down
19 changes: 14 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,15 @@
# -- General configuration ---------------------------------------------------

extensions = [
"sphinx.ext.napoleon",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinxext.rediraffe",
"sphinx_design",
"sphinx_copybutton",
"autoapi.extension",
"_extension.gallery_directive",
# For extension examples and demos
"ablog",
Expand Down Expand Up @@ -64,11 +66,6 @@
sitemap_locales = [None]
sitemap_url_scheme = "{link}"


# -- autosummary -------------------------------------------------------------

autosummary_generate = True

# -- Internationalization ----------------------------------------------------

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

# -- Options for autosummary/autodoc output ------------------------------------
autosummary_generate = True
autodoc_typehints = "description"
autodoc_member_order = "groupwise"

# -- Options for autoapi -------------------------------------------------------
autoapi_type = "python"
autoapi_dirs = ["../src/pydata_sphinx_theme"]
autoapi_keep_files = True
autoapi_root = "api"
autoapi_member_order = "groupwise"

# -- application setup -------------------------------------------------------


Expand Down
161 changes: 0 additions & 161 deletions docs/examples/api.rst

This file was deleted.

0 comments on commit cb23a7a

Please sign in to comment.