DOC: use sphinx-apipages extension (#155)

* DOC: use sphinx-apipages extension * Fix linter
audeering · Jan 24, 2024 · 5700815 · 5700815
1 parent 28a2f59
commit 5700815
Show file tree

Hide file tree

Showing 5 changed files with 2 additions and 48 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
 
@@ -29,18 +27,16 @@
     '.DS_Store',
     'api-src',
 ]
-templates_path = ['_templates']
 pygments_style = None
 extensions = [
     'jupyter_sphinx',
-    'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',  # support for Google-style docstrings
-    'sphinx.ext.autosummary',
     'sphinx_autodoc_typehints',
     'sphinx.ext.viewcode',
     'sphinx.ext.intersphinx',
     'sphinx.ext.autosectionlabel',
     'sphinx_copybutton',  # for "copy to clipboard" buttons
+    'sphinx_apipages',
 ]
 intersphinx_mapping = {
     'audformat': ('https://audeering.github.io/audformat/', None),
@@ -70,10 +66,6 @@
 copybutton_prompt_text = r'>>> |\.\.\. |$ '
 copybutton_prompt_is_regexp = True
 
-# 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'
 html_theme_options = {
@@ -85,13 +77,3 @@
     'display_github': True,
 }
 html_title = title
-
-# Copy API (sub-)module RST files to docs/api/ folder ---------------------
-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
@@ -6,6 +6,7 @@ jupyter-sphinx
 librosa
 pyarrow
 sphinx
+sphinx-apipages >=0.1.2
 sphinx-audeering-theme >=1.2.1
 sphinx-autodoc-typehints
 sphinx-copybutton