From f8e4f366d0499d550e5f67d56b6f4969f6bda68d Mon Sep 17 00:00:00 2001 From: L-Nafaryus Date: Tue, 10 Aug 2021 16:00:55 +0500 Subject: [PATCH] Mod: docs --- anisotropy/core/cli.py | 2 +- anisotropy/core/main.py | 1 + docs/source/anisotropy.core.rst | 45 +++++++++++++++++++ docs/source/anisotropy.openfoam.rst | 69 +++++++++++++++++++++++++++++ docs/source/anisotropy.rst | 56 ++++------------------- docs/source/anisotropy.salomepl.rst | 37 ++++++++++++++++ docs/source/anisotropy.samples.rst | 37 ++++++++++++++++ docs/source/conf.py | 4 +- docs/source/modules.rst | 3 +- docs/source/openfoam.rst | 69 ----------------------------- docs/source/salomepl.rst | 37 ---------------- docs/source/setup.rst | 7 +++ docs/source/static/.gitkeep | 0 docs/source/templates/.gitkeep | 0 14 files changed, 208 insertions(+), 159 deletions(-) create mode 100644 docs/source/anisotropy.core.rst create mode 100644 docs/source/anisotropy.openfoam.rst create mode 100644 docs/source/anisotropy.salomepl.rst create mode 100644 docs/source/anisotropy.samples.rst delete mode 100644 docs/source/openfoam.rst delete mode 100644 docs/source/salomepl.rst create mode 100644 docs/source/setup.rst create mode 100644 docs/source/static/.gitkeep create mode 100644 docs/source/templates/.gitkeep diff --git a/anisotropy/core/cli.py b/anisotropy/core/cli.py index 61210bb..1bc73d6 100644 --- a/anisotropy/core/cli.py +++ b/anisotropy/core/cli.py @@ -82,4 +82,4 @@ def _compute_mesh(root, name, direction, theta): ### # CLI entry ## -anisotropy() +#anisotropy() diff --git a/anisotropy/core/main.py b/anisotropy/core/main.py index 48eeaba..231e9c9 100644 --- a/anisotropy/core/main.py +++ b/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 diff --git a/docs/source/anisotropy.core.rst b/docs/source/anisotropy.core.rst new file mode 100644 index 0000000..d5fc98e --- /dev/null +++ b/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: diff --git a/docs/source/anisotropy.openfoam.rst b/docs/source/anisotropy.openfoam.rst new file mode 100644 index 0000000..d24313c --- /dev/null +++ b/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: diff --git a/docs/source/anisotropy.rst b/docs/source/anisotropy.rst index d2bc676..844840b 100644 --- a/docs/source/anisotropy.rst +++ b/docs/source/anisotropy.rst @@ -1,56 +1,16 @@ anisotropy package ================== -Submodules ----------- +Subpackages +----------- -anisotropy.bodyCentered module ------------------------------- +.. toctree:: + :maxdepth: 4 -.. automodule:: anisotropy.bodyCentered - :members: - :undoc-members: - :show-inheritance: - -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: + anisotropy.core + anisotropy.openfoam + anisotropy.salomepl + anisotropy.samples Module contents --------------- diff --git a/docs/source/anisotropy.salomepl.rst b/docs/source/anisotropy.salomepl.rst new file mode 100644 index 0000000..dff673f --- /dev/null +++ b/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: diff --git a/docs/source/anisotropy.samples.rst b/docs/source/anisotropy.samples.rst new file mode 100644 index 0000000..bc32db3 --- /dev/null +++ b/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: diff --git a/docs/source/conf.py b/docs/source/conf.py index e599a43..f56a150 100644 --- a/docs/source/conf.py +++ b/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'] diff --git a/docs/source/modules.rst b/docs/source/modules.rst index 496ffb8..bfbe537 100644 --- a/docs/source/modules.rst +++ b/docs/source/modules.rst @@ -5,5 +5,4 @@ anisotropy :maxdepth: 4 anisotropy - salomepl - openfoam + setup diff --git a/docs/source/openfoam.rst b/docs/source/openfoam.rst deleted file mode 100644 index 11057a8..0000000 --- a/docs/source/openfoam.rst +++ /dev/null @@ -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: diff --git a/docs/source/salomepl.rst b/docs/source/salomepl.rst deleted file mode 100644 index 90bd206..0000000 --- a/docs/source/salomepl.rst +++ /dev/null @@ -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: diff --git a/docs/source/setup.rst b/docs/source/setup.rst new file mode 100644 index 0000000..552eb49 --- /dev/null +++ b/docs/source/setup.rst @@ -0,0 +1,7 @@ +setup module +============ + +.. automodule:: setup + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/static/.gitkeep b/docs/source/static/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/docs/source/templates/.gitkeep b/docs/source/templates/.gitkeep new file mode 100644 index 0000000..e69de29