DOC: improved documentation

saullocastro · Mar 9, 2024 · f2c9cfe · f2c9cfe
1 parent 3171d00
commit f2c9cfe
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 17 deletions.
diff --git a/composites/__init__.py b/composites/__init__.py
@@ -1,12 +1,12 @@
 r"""
-===================================================================
-Methods to calculate composite plate properties (:mod:`composites`)
-===================================================================
+=====================================
+API documentation (:mod:`composites`)
+=====================================
 
 .. currentmodule::composites
 
-The ``composites`` module includes functions used to calculate plate properties
-for laminated composites and isotropic plates.
+The ``composites`` module includes functions used to calculate properties and
+perform analysis on laminated composites and isotropic plates.
 
 Classical and first-order shear deformation theories are supported. For
 classical plate theories or classical laminated plate theories (CLPT), the

diff --git a/composites/kassapoglou.py b/composites/kassapoglou.py
@@ -1,11 +1,14 @@
 r"""
-===========================================================================
-Implementations based on Kassapoglou's book (:mod:`composites.kassapoglou`)
-===========================================================================
+=====================================================
+Kassapoglou's methods (:mod:`composites.kassapoglou`)
+=====================================================
 
 .. currentmodule::composites.kassapoglou
 
 
+Methods based on Kassapoglou's book.
+
+
 Reference:
 
     Kassapoglou. Design and Analysis of Composite Structures. 2nd Edition. John Wiley & Sons Ltd, 2013.

diff --git a/doc/source/api.rst b/doc/source/api.rst
@@ -0,0 +1,2 @@
+.. automodule:: composites
+    :members:
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -1,9 +1,8 @@
 Documentation for the ``composites`` module
 ===========================================
 
-High-performance module to calculate properties of laminated composite
-materials, and constraints such as buckling. Usually, this module is used to
-calculate:
+High-performance module to calculate properties and perform analysis on
+composites. With the ``composites`` module, you are able to calculate:
 
 * A, B, D, E plane-stress stiffness matrices for plates
     - A, B, D, for classical plate theory (CLT, or CLPT)
@@ -15,6 +14,9 @@ calculate:
 
 * Stiffness matrices (ABDE) based on lamination parameters
 
+* Based on Kassapoglou's book, local buckling under compression, shear, and
+  post-buckling 
+
 
 Code repository
 ---------------
@@ -37,11 +39,13 @@ Bibtex :
         }
 
 
-Classes and functions
----------------------
+API Documentation
+-----------------
+
+.. toctree::
+    :maxdepth: 1
 
-.. automodule:: composites
-    :members:
+    api.rst
 
 
 License

diff --git a/doc/source/kassapoglou.rst b/doc/source/kassapoglou.rst