enh: add quickstart

rafaelpsilva07 · Jan 21, 2024 · dedfb11 · dedfb11
1 parent 8fbf63f
commit dedfb11
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 16 deletions.
diff --git a/composipy/optimize/__init__.py b/composipy/optimize/__init__.py
@@ -2,4 +2,6 @@
 
 from ._maximize_buckling import maximize_buckling_load
 from ._minimize_panel_weight import minimize_panel_weight
-from ._calculate_lp_proportions import calc_lp_proportions
+
+
+__all__ = ['maximize_buckling_load', 'minimize_panel_weight']
diff --git a/composipy/version.py b/composipy/version.py
@@ -1 +1 @@
-__version__ = '1.1.1'
+__version__ = '1.2.1'
diff --git a/doc/conf.py b/doc/conf.py
@@ -45,6 +45,7 @@
 
 #html_theme = 'alabaster'
 html_theme = 'pydata_sphinx_theme'
+#html_theme = 'renku'
 #html_theme_path = [pydata_sphinx_theme.get_html_theme_path()]
 #html_theme = 'yummy_sphinx_theme'
 #html_theme = 'sphinx-readable-theme'

diff --git a/doc/index.rst b/doc/index.rst
@@ -3,15 +3,17 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+This page provides documentation for composipy project.
+Composipy has functions to calculate classical laminate theory, buckling, lamination parameters and optimization.
 
-.. mdinclude :: ../README.md 
 
 Contents
 ========
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
-   Examples <notebooks/index>
-   Code References <reference/index>
+   Quick Start <quickstart>
+   Code References <reference/index>
+   Examples <notebooks/index>
diff --git a/doc/quickstart.rst b/doc/quickstart.rst
@@ -0,0 +1 @@
+.. mdinclude :: ../README.md 
diff --git a/doc/reference/NastranAPI.rst b/doc/reference/NastranAPI.rst
@@ -1,7 +1,10 @@
 Nastran API functions
 =====================
+This page contains functions to be used with NASTRAN solver.
 
 
+Generator of NASTRAN PCOMP property
+-----------------------------------
 .. automodule:: composipy.nastranapi.pcomp_generator
   :members:
 

diff --git a/doc/reference/classes.rst b/doc/reference/classes.rst
@@ -1,20 +1,22 @@
-OrthotropicMaterial
-===================
+Composipy Classes
+=================
+This page contains Composipy classes, used to build the main instances of the package.
 
 
+OrthotropicMaterial
+-------------------
 .. autoclass:: composipy.OrthotropicMaterial
   :members:
 
 
 LaminateProperty
-================
-
-
+----------------
 .. autoclass:: composipy.LaminateProperty
   :members:
 
 
 PlateStructure
-==============
+--------------
 .. autoclass:: composipy.PlateStructure
-  :members:
+  :members:
+
diff --git a/doc/reference/index.rst b/doc/reference/index.rst
@@ -1,12 +1,12 @@
 Code references
 ===============
-
-Code classes, methods, attributes, functions and APIs are listed below.
+This page contains Composipy classes, methods, attributes, functions and APIs.
 
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Contents:
 
    Composipy classes <classes>
+   Composipy functions <optimization_functions>
    Composipy APIs <NastranAPI>