diff --git a/README.rst b/README.rst index a6b1c4e390f9d265278cb618de85d7c9f928650b..0b5d5f4eab859467fa0b032c2be29b35432f1e5f 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 a302f7e2ddef81e54d86bb04f85d8044f4eb3eaf..48da7ef8bc83a93e605f94b72fd0502543eceeff 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 0ccc0a91d3456a33ee9997f178388be451451f59..ac3f757b4d6e157c8e835fb2648030e73032059e 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 e02a44c8ebbf7ffb93205349638d412ff0235605..6e1cb48af7aeac96bcf022498c80c4e042c7caaa 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 d36fac35859d09432eb7db5203c3b78a3516b32a..4f175c7f95191d414ba040daba075fb44fea38bd 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