From 5466ad2ec7ee0635af9eb30fe488d6eb4f5a6dff Mon Sep 17 00:00:00 2001
From: Cristian C Lalescu <Cristian.Lalescu@ds.mpg.de>
Date: Sun, 24 Jan 2016 10:43:00 +0100
Subject: [PATCH] fix doc generation
---
documentation/_static/api.rst | 38 +++++++++++++++++++++++++++--------
documentation/conf.py | 2 +-
2 files changed, 31 insertions(+), 9 deletions(-)
diff --git a/documentation/_static/api.rst b/documentation/_static/api.rst
index 68278ad8..30ad9c2f 100644
--- a/documentation/_static/api.rst
+++ b/documentation/_static/api.rst
@@ -2,22 +2,22 @@
API
===
+
----------
bfps.tools
----------
-.. automodule:: tools
+.. automodule:: bfps.tools
:members:
:undoc-members:
- :inherited-members:
:show-inheritance:
--------------
-bfps.Launcher
--------------
+-----------------
+bfps.NavierStokes
+-----------------
-.. autoclass:: Launcher.Launcher
+.. automodule:: bfps.NavierStokes
:members:
:undoc-members:
:inherited-members:
@@ -25,10 +25,32 @@ bfps.Launcher
-----------------
-bfps.NavierStokes
+bfps.FluidConvert
-----------------
-.. autoclass:: NavierStokes.NavierStokes
+.. automodule:: bfps.FluidConvert
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :show-inheritance:
+
+
+----------------
+bfps.FluidResize
+----------------
+
+.. automodule:: bfps.FluidResize
+ :members:
+ :undoc-members:
+ :inherited-members:
+ :show-inheritance:
+
+
+-------------
+bfps.Launcher
+-------------
+
+.. automodule:: bfps.Launcher
:members:
:undoc-members:
:inherited-members:
diff --git a/documentation/conf.py b/documentation/conf.py
index 6e1cb48a..5fc2f866 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -21,7 +21,7 @@ import shlex
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
-sys.path.append(os.path.abspath('../bfps'))
+sys.path.insert(0, os.path.abspath('..'))
# -- General configuration ------------------------------------------------
--
GitLab