doc: enable apidoc generation

Signed-off-by: Jan Luebbe <jlu@pengutronix.de>
labgrid-project · Mar 20, 2017 · d847710 · d847710
1 parent 8f6f770
commit d847710
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -156,4 +156,17 @@
 ]
 
 
+# -- Options for autodoc --------------------------------------------------
 
+autodoc_member_order = 'bysource'
+autodoc_mock_imports = ['onewire', 'txaio']
+
+def run_apidoc(app):
+    from sphinx.apidoc import main
+    module = os.path.abspath(os.path.join(app.srcdir, '..', 'labgrid'))
+    output = os.path.abspath(os.path.join(app.srcdir, 'modules'))
+    cmd = ['sphinx-apidoc', module, '-M', '-H', 'Modules', '-o', output]
+    main(cmd)
+
+def setup(app):
+    app.connect('builder-inited', run_apidoc)
diff --git a/doc/index.rst b/doc/index.rst
@@ -12,6 +12,7 @@ Welcome to labgrid's documentation!
    development
    components
    design_decisions
+   modules/modules
    :maxdepth: 2
    :caption: Contents: