DOC: use sphinx-apipages extension (#412)

audeering · Jan 24, 2024 · 2f81002 · 2f81002
1 parent 7972887
commit 2f81002
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 49 deletions.
diff --git a/docs/_templates/autosummary/base.rst b/docs/_templates/autosummary/base.rst
diff --git a/docs/_templates/autosummary/class.rst b/docs/_templates/autosummary/class.rst
diff --git a/docs/_templates/autosummary/function.rst b/docs/_templates/autosummary/function.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -1,6 +1,4 @@
 from datetime import date
-import os
-import shutil
 
 import toml
 
@@ -32,20 +30,18 @@
     "emodb-src",
     "__pycache__",
 ]
-templates_path = ["_templates"]
 pygments_style = None
 extensions = [
     "sphinx.ext.graphviz",
-    "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",  # support for Google-style docstrings
-    "sphinx.ext.autosummary",
     "sphinx_autodoc_typehints",
     "sphinx.ext.autosectionlabel",
     "sphinx.ext.viewcode",
     "sphinx.ext.intersphinx",
     "sphinx_copybutton",
     "sphinxcontrib.katex",  # has to be before jupyter_sphinx
     "jupyter_sphinx",
+    "sphinx_apipages",
 ]
 
 napoleon_use_ivar = True  # List of class attributes
@@ -79,10 +75,16 @@
 # Graphviz figures
 graphviz_output_format = "svg"
 
-# Disable auto-generation of TOC entries in the API
-# https://github.com/sphinx-doc/sphinx/issues/6316
-toc_object_entries = False
-
+apipages_hidden_methods = [
+    "__add__",
+    "__call__",
+    "__contains__",
+    "__eq__",
+    "__getitem__",
+    "__iter__",
+    "__len__",
+    "__setitem__",
+]
 
 # HTML --------------------------------------------------------------------
 html_theme = "sphinx_audeering_theme"
@@ -96,14 +98,3 @@
     "display_github": True,
 }
 html_title = title
-
-
-# Copy API (sub-)module RST files to docs/api/ folder ---------------------
-audeer.rmdir("api")
-audeer.mkdir("api")
-api_src_files = audeer.list_file_names("api-src")
-api_dst_files = [
-    audeer.path("api", os.path.basename(src_file)) for src_file in api_src_files
-]
-for src_file, dst_file in zip(api_src_files, api_dst_files):
-    shutil.copyfile(src_file, dst_file)
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,6 +3,7 @@ ipykernel
 jupyter-sphinx
 pyarrow  # https://github.com/pandas-dev/pandas/issues/54466
 sphinx
+sphinx-apipages >=0.1.2
 sphinx-audeering-theme >=1.2.1
 sphinx-autodoc-typehints
 sphinx-copybutton