From 39b742bed0179609083ba894aac101a5c19613ed Mon Sep 17 00:00:00 2001 From: Martin Gallo Date: Tue, 14 Feb 2017 18:55:16 -0300 Subject: [PATCH 1/3] Playing with sphinx-autoapi --- docs/conf.py | 9 +++++---- docs/index.rst | 4 ++-- requirements-docs.txt | 1 + 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index ec8b29c..d4dee1a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -32,11 +32,16 @@ # ones. extensions = [ 'sphinx.ext.autodoc', + 'autoapi.extension', 'sphinx.ext.viewcode', 'nbsphinx', 'sphinx.ext.mathjax', ] +# Document Python Code +autoapi_type = 'python' +autoapi_dirs = ['../pysap'] + # Disable notebook cell execution timeout nbsphinx_timeout = 90 @@ -269,7 +274,3 @@ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False - - -# Automatically build API docs -apidoc_main(["-f", "-e", "-M", "-o", "api/", "../pysap"]) diff --git a/docs/index.rst b/docs/index.rst index bbff1f8..ce43dbe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -57,10 +57,10 @@ Content :maxdepth: 3 user/user - protocols/protocols + dev/dev examples/examples + protocols/protocols api/api - dev/dev .. examples/examples diff --git a/requirements-docs.txt b/requirements-docs.txt index 153ec37..2bbf68d 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1,4 +1,5 @@ Sphinx>=1.4 +sphinx-autoapi ipykernel nbconvert nbsphinx From e14a724aa95b3ba940060cff2e787c0e0d6f9ffe Mon Sep 17 00:00:00 2001 From: Martin Gallo Date: Fri, 17 Feb 2017 18:21:54 -0300 Subject: [PATCH 2/3] Removing files from gitignore --- .gitignore | 2 -- 1 file changed, 2 deletions(-) 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 From 7e2903f71a6efa7070cf60e4877b38f30b3d65e6 Mon Sep 17 00:00:00 2001 From: Martin Gallo Date: Tue, 21 Feb 2017 17:38:36 -0300 Subject: [PATCH 3/3] Removing pysap from API index as it's covered by autoapi --- docs/api/index.rst | 1 - 1 file changed, 1 deletion(-) 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 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