diff --git a/.gitignore b/.gitignore index f253e6b..ee92310 100644 --- a/.gitignore +++ b/.gitignore @@ -50,8 +50,6 @@ coverage.xml # Sphinx documentation docs/_build/ -docs/api/modules.rst -docs/api/pysap.*rst docs/**/.ipynb_checkpoints/ docs/**/*.tex docs/**/*.dvi diff --git a/docs/api/index.rst b/docs/api/index.rst index 8aa00e4..d659fc4 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -8,5 +8,4 @@ This part of the documentation covers the developer interfaces of pysap. .. toctree:: :maxdepth: 2 - pysap pysapcompress diff --git a/docs/conf.py b/docs/conf.py index dad67e1..f26ba26 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -42,12 +42,23 @@ # ones. extensions = [ 'sphinx.ext.autodoc', + 'autoapi.extension', 'sphinx.ext.viewcode', 'nbsphinx', 'sphinx.ext.mathjax', 'm2r', ] +# Document Python Code +autoapi_type = 'python' +autoapi_dirs = ['../pysap'] + +# Disable notebook cell execution timeout +nbsphinx_timeout = 90 + +# Allow errors on nbsphinx +nbsphinx_allow_errors = True + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -161,31 +172,14 @@ 'Miscellaneous'), ] +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' -# Automatically build API docs -def run_apidoc(_): - ignore_paths = [ - ] - - argv = [ - "-f", - "-T", - "-e", - "-M", - "-o", "api/", - "../pysap" - ] + ignore_paths - - try: - # Sphinx 1.7+ - from sphinx.ext import apidoc - apidoc.main(argv) - except ImportError: - # Sphinx 1.6 (and earlier) - from sphinx import apidoc - argv.insert(0, apidoc.__file__) - apidoc.main(argv) - - -def setup(app): - app.connect('builder-inited', run_apidoc) +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/requirements-docs.txt b/requirements-docs.txt index b06db23..04e7575 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,4 +1,5 @@ Sphinx==1.7.9 +sphinx-autoapi ipykernel nbsphinx pyx==0.12.1 pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy