DOC: use sphinx-apipages extension (#163)

audeering · Jan 10, 2024 · 73b1efc · 73b1efc
1 parent 121f374
commit 73b1efc
Show file tree

Hide file tree

Showing 5 changed files with 2 additions and 50 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
 
@@ -30,17 +28,15 @@
     'Thumbs.db',
     '.DS_Store',
 ]
-templates_path = ['_templates']
 pygments_style = None
 extensions = [
     'jupyter_sphinx',
-    'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
-    'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode',
     'sphinx_autodoc_typehints',
     'sphinx_copybutton',
+    'sphinx_apipages',
 ]
 
 napoleon_use_ivar = True  # List of class attributes
@@ -59,10 +55,6 @@
     'pandas',
 ]
 
-# Disable auto-generation of TOC entries in the API
-# https://github.com/sphinx-doc/sphinx/issues/6316
-toc_object_entries = False
-
 
 # HTML --------------------------------------------------------------------
 html_theme = 'sphinx_audeering_theme'
@@ -75,15 +67,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
@@ -1,6 +1,7 @@
 ipykernel
 jupyter-sphinx
 sphinx
+sphinx-apipages
 sphinx-audeering-theme >=1.2.1
 sphinx-autodoc-typehints
 sphinx-copybutton