Mod: docs

anisotropy/core/cli.py

@@ -82,4 +82,4 @@ def _compute_mesh(root, name, direction, theta):
 ###
 #   CLI entry
 ##
-anisotropy()
+#anisotropy()

anisotropy/core/main.py

@@ -95,6 +95,7 @@ def timer(func):
 
     return inner
 
+from anisotropy import __version__
 from anisotropy import salomepl
 from anisotropy import openfoam
 from math import sqrt

docs/source/anisotropy.core.rst

@@ -0,0 +1,45 @@
+anisotropy.core package
+=======================
+
+Submodules
+----------
+
+anisotropy.core.cli module
+--------------------------
+
+.. automodule:: anisotropy.core.cli
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.core.main module
+---------------------------
+
+.. automodule:: anisotropy.core.main
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.core.models module
+-----------------------------
+
+.. automodule:: anisotropy.core.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.core.utils module
+----------------------------
+
+.. automodule:: anisotropy.core.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: anisotropy.core
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/anisotropy.openfoam.rst

@@ -0,0 +1,69 @@
+anisotropy.openfoam package
+===========================
+
+Submodules
+----------
+
+anisotropy.openfoam.application module
+--------------------------------------
+
+.. automodule:: anisotropy.openfoam.application
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.openfoam.meshConversion module
+-----------------------------------------
+
+.. automodule:: anisotropy.openfoam.meshConversion
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.openfoam.meshManipulation module
+-------------------------------------------
+
+.. automodule:: anisotropy.openfoam.meshManipulation
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.openfoam.miscellaneous module
+----------------------------------------
+
+.. automodule:: anisotropy.openfoam.miscellaneous
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.openfoam.parallelProcessing module
+---------------------------------------------
+
+.. automodule:: anisotropy.openfoam.parallelProcessing
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.openfoam.solvers module
+----------------------------------
+
+.. automodule:: anisotropy.openfoam.solvers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.openfoam.utils module
+--------------------------------
+
+.. automodule:: anisotropy.openfoam.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: anisotropy.openfoam
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/anisotropy.rst

@@ -1,56 +1,16 @@
 anisotropy package
 ==================
 
-Submodules
+Subpackages
-----------
+-----------
 
-anisotropy.bodyCentered module
+.. toctree::
-------------------------------
+   :maxdepth: 4
 
-.. automodule:: anisotropy.bodyCentered
+   anisotropy.core
-   :members:
+   anisotropy.openfoam
-   :undoc-members:
+   anisotropy.salomepl
-   :show-inheritance:
+   anisotropy.samples
-
-anisotropy.core module
-----------------------
-
-.. automodule:: anisotropy.core
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-anisotropy.faceCentered module
-------------------------------
-
-.. automodule:: anisotropy.faceCentered
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-anisotropy.models module
-------------------------
-
-.. automodule:: anisotropy.models
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-anisotropy.simple module
-------------------------
-
-.. automodule:: anisotropy.simple
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-anisotropy.utils module
------------------------
-
-.. automodule:: anisotropy.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
 
 Module contents
 ---------------

docs/source/anisotropy.salomepl.rst

@@ -0,0 +1,37 @@
+anisotropy.salomepl package
+===========================
+
+Submodules
+----------
+
+anisotropy.salomepl.geometry module
+-----------------------------------
+
+.. automodule:: anisotropy.salomepl.geometry
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.salomepl.mesh module
+-------------------------------
+
+.. automodule:: anisotropy.salomepl.mesh
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.salomepl.utils module
+--------------------------------
+
+.. automodule:: anisotropy.salomepl.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: anisotropy.salomepl
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/anisotropy.samples.rst

@@ -0,0 +1,37 @@
+anisotropy.samples package
+==========================
+
+Submodules
+----------
+
+anisotropy.samples.bodyCentered module
+--------------------------------------
+
+.. automodule:: anisotropy.samples.bodyCentered
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.samples.faceCentered module
+--------------------------------------
+
+.. automodule:: anisotropy.samples.faceCentered
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+anisotropy.samples.simple module
+--------------------------------
+
+.. automodule:: anisotropy.samples.simple
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: anisotropy.samples
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/conf.py

@@ -33,7 +33,7 @@ release = '1.1.0'
 extensions = ["sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ['templates']
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -51,4 +51,4 @@ html_theme = 'sphinx_rtd_theme'
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['static']

docs/source/modules.rst

@@ -5,5 +5,4 @@ anisotropy
    :maxdepth: 4
 
    anisotropy
-   salomepl
+   setup
-   openfoam

docs/source/openfoam.rst

@@ -1,69 +0,0 @@
-openfoam package
-================
-
-Submodules
-----------
-
-openfoam.application module
----------------------------
-
-.. automodule:: openfoam.application
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-openfoam.meshConversion module
-------------------------------
-
-.. automodule:: openfoam.meshConversion
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-openfoam.meshManipulation module
---------------------------------
-
-.. automodule:: openfoam.meshManipulation
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-openfoam.miscellaneous module
------------------------------
-
-.. automodule:: openfoam.miscellaneous
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-openfoam.parallelProcessing module
-----------------------------------
-
-.. automodule:: openfoam.parallelProcessing
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-openfoam.solvers module
------------------------
-
-.. automodule:: openfoam.solvers
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-openfoam.utils module
----------------------
-
-.. automodule:: openfoam.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: openfoam
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/salomepl.rst

@@ -1,37 +0,0 @@
-salomepl package
-================
-
-Submodules
-----------
-
-salomepl.geometry module
-------------------------
-
-.. automodule:: salomepl.geometry
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-salomepl.mesh module
---------------------
-
-.. automodule:: salomepl.mesh
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-salomepl.utils module
----------------------
-
-.. automodule:: salomepl.utils
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: salomepl
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/setup.rst

@@ -0,0 +1,7 @@
+setup module
+============
+
+.. automodule:: setup
+   :members:
+   :undoc-members:
+   :show-inheritance: