From dedfb11fe36e8cd6387896eb5245326f24f7b4fc Mon Sep 17 00:00:00 2001 From: Rafael Date: Sun, 21 Jan 2024 16:55:14 -0300 Subject: [PATCH] enh: add quickstart --- composipy/optimize/__init__.py | 4 +++- composipy/version.py | 2 +- doc/conf.py | 1 + doc/index.rst | 10 ++++++---- doc/quickstart.rst | 1 + doc/reference/NastranAPI.rst | 3 +++ doc/reference/classes.rst | 16 +++++++++------- doc/reference/index.rst | 6 +++--- 8 files changed, 27 insertions(+), 16 deletions(-) create mode 100644 doc/quickstart.rst diff --git a/composipy/optimize/__init__.py b/composipy/optimize/__init__.py index 5448d0e..d08307d 100644 --- 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 \ No newline at end of file + + +__all__ = ['maximize_buckling_load', 'minimize_panel_weight'] \ No newline at end of file diff --git a/composipy/version.py b/composipy/version.py index e9e169e..ce34e91 100644 --- a/composipy/version.py +++ b/composipy/version.py @@ -1 +1 @@ -__version__ = '1.1.1' \ No newline at end of file +__version__ = '1.2.1' \ No newline at end of file diff --git a/doc/conf.py b/doc/conf.py index 97ca277..f5a41d9 100644 --- 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 index 5112af0..6c62d1d 100644 --- 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 - Code References \ No newline at end of file + Quick Start + Code References + Examples \ No newline at end of file diff --git a/doc/quickstart.rst b/doc/quickstart.rst new file mode 100644 index 0000000..7ab42c6 --- /dev/null +++ b/doc/quickstart.rst @@ -0,0 +1 @@ +.. mdinclude :: ../README.md \ No newline at end of file diff --git a/doc/reference/NastranAPI.rst b/doc/reference/NastranAPI.rst index 8bfffe7..217920a 100644 --- 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 index ca2b7de..fc73149 100644 --- 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: \ No newline at end of file + :members: + diff --git a/doc/reference/index.rst b/doc/reference/index.rst index 5c56161..8630257 100644 --- 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 + Composipy functions Composipy APIs