Create auto generate Python API document for blueoil/ directory.

blue-oil · Apr 15, 2020 · 7288673 · 7288673
1 parent 82a6141
commit 7288673
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -66,6 +66,7 @@
     'sphinx.ext.autosummary',
     'sphinx.ext.napoleon',
     'sphinx.ext.mathjax',
+    'autoapi.extension'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -195,6 +196,13 @@
 ]
 
 
+# -- Automatically run sphinx-autoapi --------------------------------------
+autoapi_type = 'python'
+autoapi_dirs = ['../blueoil']
+autoapi_file_patterns = ['*.py']
+autoapi_ignore = ['*/templates/*', '*/configs/*']
+
+
 # -- Extension configuration -------------------------------------------------
 def setup(app):
         app.add_config_value('recommonmark_config', {

diff --git a/docs/index.rst b/docs/index.rst
@@ -17,3 +17,4 @@ Blueoil -- An efficient neural network generator
    reference/index
    converter/index
    quantize/index
+   autoapi/index
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,6 +2,9 @@ sphinx==2.4.4
 recommonmark
 sphinx_rtd_theme
 
+# for autoapi doc
+sphinx-autoapi
+
 # for autodoc of lmnet.
 numpy
 Pillow