Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: use sphinx-apipages extension #130

Merged
merged 3 commits into from
Jan 10, 2024
Merged

DOC: use sphinx-apipages extension #130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a33632f
DOC: use sphinx-apipages extension
hagenw Jan 10, 2024
df10ad5
Require sphinx-apipages>=0.1.2
hagenw Jan 10, 2024
c730999
Specify hidden class methods to be included
hagenw Jan 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/_templates/autosummary/base.rst
View file
Open in desktop

This file was deleted.

19 changes: 0 additions & 19 deletions docs/_templates/autosummary/class.rst
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions docs/_templates/autosummary/function.rst
View file
Open in desktop

This file was deleted.

33 changes: 11 additions & 22 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
import os
import shutil

import audeer


Expand All @@ -21,16 +18,14 @@
'.DS_Store',
'api-src',
]
templates_path = ['_templates']
pygments_style = None
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon', # support for Google-style docstrings
'sphinx.ext.autosummary',
'sphinx_autodoc_typehints',
'sphinx_copybutton',
'sphinx.ext.viewcode',
'sphinx.ext.intersphinx',
'sphinx_apipages',
]
intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
Expand All @@ -44,10 +39,16 @@
autodoc_default_options = {
'undoc-members': False,
}

# Disable auto-generation of TOC entries in the API
# https://github.com/sphinx-doc/sphinx/issues/6316
toc_object_entries = False
apipages_hidden_methods = [
'__call__',
'__eq__',
'__lt__',
'__le__',
'__gt__',
'__ge__',
'__repr__',
'__str__',
]


# HTML --------------------------------------------------------------------
Expand All @@ -61,15 +62,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)
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
sphinx >=3.0.0
sphinx-apipages >=0.1.2
sphinx-audeering-theme >=1.1.4
sphinx_autodoc_typehints
sphinx-copybutton