From 56ae48caaa6dfea35d16f57278669afab24ddec4 Mon Sep 17 00:00:00 2001 From: Cristian C Lalescu <Cristian.Lalescu@ds.mpg.de> Date: Fri, 22 Jan 2016 15:35:31 +0100 Subject: [PATCH] docs use repository bfps instead of installed bfps --- README.rst | 1 - bfps/tools.py | 4 ++-- documentation/_static/api.rst | 13 ++----------- documentation/conf.py | 1 + documentation/index.rst | 10 +++++----- 5 files changed, 10 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index a6b1c4e3..0b5d5f4e 100644 --- a/README.rst +++ b/README.rst @@ -1,4 +1,3 @@ -================================ Big Fluid and Particle Simulator ================================ diff --git a/bfps/tools.py b/bfps/tools.py index a302f7e2..48da7ef8 100644 --- a/bfps/tools.py +++ b/bfps/tools.py @@ -85,9 +85,9 @@ def randomize_phases(v): randomize the phases (assuming that the initial field is complex valued; otherwise I'm not sure what will come out). - :param v: `numpy.array` of dimension at least 3. + :param v: ``numpy.array`` of dimension at least 3. - :returns: `v` with randomized phases (i.e. a Gaussian random field). + :returns: ``v`` with randomized phases (i.e. a Gaussian random field). """ phi = np.random.random(v.shape[:3])*(2*np.pi) phi[0, 0, 0] = 0.0 diff --git a/documentation/_static/api.rst b/documentation/_static/api.rst index 0ccc0a91..ac3f757b 100644 --- a/documentation/_static/api.rst +++ b/documentation/_static/api.rst @@ -1,19 +1,10 @@ API === -bfps ----- - -.. automodule:: bfps - :members: - :undoc-members: - :inherited-members: - :show-inheritance: - bfps.NavierStokes ----------------- -.. automodule:: bfps.NavierStokes +.. autoclass:: NavierStokes.NavierStokes :members: :undoc-members: :inherited-members: @@ -22,7 +13,7 @@ bfps.NavierStokes bfps.tools ---------- -.. automodule:: bfps.tools +.. automodule:: tools :members: :undoc-members: :inherited-members: diff --git a/documentation/conf.py b/documentation/conf.py index e02a44c8..6e1cb48a 100644 --- a/documentation/conf.py +++ b/documentation/conf.py @@ -21,6 +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')) # -- General configuration ------------------------------------------------ diff --git a/documentation/index.rst b/documentation/index.rst index d36fac35..4f175c7f 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -8,12 +8,12 @@ Welcome to bfps's documentation! ================================ .. toctree:: - :maxdepth: 2 + :maxdepth: 2 - /_static/README - /_static/overview - /_static/development - /_static/api + /_static/README + /_static/overview + /_static/development + /_static/api Indices and tables -- GitLab