Move generation of api-docs from generate-apidoc script to conf.py.

FEniCS · Aug 2, 2016 · 12e92cf · 12e92cf
1 parent 2ac6853
commit 12e92cf
Show file tree

Hide file tree

Showing 5 changed files with 20 additions and 330 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,3 +5,4 @@
 /FIAT.egg-info/
 
 /.cache/
+/doc/sphinx/source/api-doc
diff --git a/doc/sphinx/generate-apidoc b/doc/sphinx/generate-apidoc
diff --git a/doc/sphinx/source/api-doc/FIAT.rst b/doc/sphinx/source/api-doc/FIAT.rst
diff --git a/doc/sphinx/source/api-doc/modules.rst b/doc/sphinx/source/api-doc/modules.rst
diff --git a/doc/sphinx/source/conf.py b/doc/sphinx/source/conf.py
@@ -271,3 +271,22 @@
 
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'http://docs.python.org/': None}
+
+
+def run_apidoc(_):
+    modules = ['FIAT']
+
+    # Get location of Sphinx files
+    sphinx_source_dir = os.path.abspath(os.path.dirname(__file__))
+    repo_dir = os.path.abspath(os.path.join(sphinx_source_dir, os.path.pardir,
+                                            os.path.pardir, os.path.pardir))
+    apidoc_dir = os.path.join(sphinx_source_dir, "api-doc")
+
+    from sphinx.apidoc import main
+    for module in modules:
+        # Generate .rst files ready for autodoc
+        module_dir = os.path.join(repo_dir, module)
+        main(["-f", "-d", "1", "-o", apidoc_dir, module_dir])
+
+def setup(app):
+    app.connect('builder-inited', run_apidoc)