Work in progress

t-rexdex · Mar 1, 2022 · 02bff5a · 02bff5a
1 parent 2f76c3b
commit 02bff5a
Show file tree

Hide file tree

Showing 4 changed files with 145 additions and 0 deletions.
diff --git a/doc/index.rst b/doc/index.rst
@@ -17,6 +17,7 @@ Contents:
    usermanual
    develop 
    api   
+   modules
 
 
 Indices and tables

diff --git a/doc/modules.rst b/doc/modules.rst
@@ -0,0 +1,11 @@
+pyfem-GITHUB
+============
+
+.. toctree::
+   :maxdepth: 4
+
+   PyFEM
+   XPyFEM
+   install
+   pyfem
+   setup
diff --git a/doc/pyfem.rst b/doc/pyfem.rst
@@ -0,0 +1,23 @@
+pyfem package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    pyfem.core
+    pyfem.elements
+    pyfem.fem
+    pyfem.io
+    pyfem.materials
+    pyfem.solvers
+    pyfem.util
+
+Module contents
+---------------
+
+.. automodule:: pyfem
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/pyfem.util.rst b/doc/pyfem.util.rst
@@ -0,0 +1,110 @@
+pyfem.util package
+==================
+
+Submodules
+----------
+
+pyfem.util.BaseModule module
+----------------------------
+
+.. automodule:: pyfem.util.BaseModule
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.BezierShapeFunctions module
+--------------------------------------
+
+.. automodule:: pyfem.util.BezierShapeFunctions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.dataStructures module
+--------------------------------
+
+.. automodule:: pyfem.util.dataStructures
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.fileParser module
+----------------------------
+
+.. automodule:: pyfem.util.fileParser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.itemList module
+--------------------------
+
+.. automodule:: pyfem.util.itemList
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.kinematics module
+----------------------------
+
+.. automodule:: pyfem.util.kinematics
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.logger module
+------------------------
+
+.. automodule:: pyfem.util.logger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.plotUtils module
+---------------------------
+
+.. automodule:: pyfem.util.plotUtils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.shapeFunctions module
+--------------------------------
+
+.. automodule:: pyfem.util.shapeFunctions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.transformations module
+---------------------------------
+
+.. automodule:: pyfem.util.transformations
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.utilFunctions module
+-------------------------------
+
+.. automodule:: pyfem.util.utilFunctions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pyfem.util.vtkUtils module
+--------------------------
+
+.. automodule:: pyfem.util.vtkUtils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: pyfem.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,6 +17,7 @@ Contents: @@
        usermanual
        develop
        api
+       modules
     Indices and tables
@@ Expand Down @@