update documentation generation, bump version to 0.3.0

Author: gituser789

README.rst

@@ -27,24 +27,24 @@ Functionality examples
 * GUI is experimental, 
 * reluctance module is currently working for a single optimization example and not fully implemented yet.
 
-1. Detailed Documentation
+Detailed Documentation
 -------------------------
 
 Can be found
 `here <https://upb-lea.github.io/FEM_Magnetics_Toolbox/main/intro.html>`__.
 
-2. Installation
+Installation
 ---------------
 
-2.1 ONELAB installation
+ONELAB installation
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 -  Go to https://onelab.info/
 -  Download the Desktop Version for your OS (Windows, Linux or macOS)
 -  Unpack the software and remember the file path. This will be needed
    later when installing FEMMT.
 
-2.2 Install FEMMT
+Install FEMMT
 ~~~~~~~~~~~~~~~~~
 
 Chose to install the development version of FEMMT or the release
@@ -73,21 +73,21 @@ Also have a look at the . `developers notes </developers_notes.md>`__.
    git clone git@github.com:upb-lea/FEM_Magnetics_Toolbox.git
    pip install -e .
 
-2.3 Minimal example and first run
+Minimal example and first run
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Run the example from here:
 `basic_example.py </femmt/examples/basic_example.py>`__. FEMMT will ask
 you for the installation path of ONELAB during first use.
 
-3. Examples
+Examples
 -----------
 
 This toolbox is able to build a complete FEM simulation from simple
 Python code. The following figure shows the Python code on the left and
 the corresponding FEM simulation on the right. |image1|
 
-3.1 Basics
+Basics
 ~~~~~~~~~~
 
 Code examples can be found in this `example
@@ -125,15 +125,15 @@ In it you can find
 For more information about the possible winding types, please
 have a look `here <winding_overview.md>`__.
 
-3.2 Counting arrow system
+Counting arrow system
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Defined as depicted here:
 
 |image3|
 
-4. GUI
-------
+GUI (Experimental)
+-------------------
 
 There is a first preview for a GUI. Installing this is a bit cumbersome
 at first, but will be simplified in the future: 
@@ -146,37 +146,37 @@ Please note, the GUI is experimental.
 
 |image2|
 
-5. Roadmap
+Roadmap
 ----------
 
 Planned features in 2022: 
 
 * Software stability and general improvements, 
 * add more Functionality to the GUI, 
 
-6. Bug Reports
+Bug Reports
 --------------
 
 Please use the issues report button within github to report bugs.
 
-7. Contributing
+Contributing
 ---------------
 
 Pull requests are welcome. For major changes, please open an issue first
 to discuss what you would like to change. For contributing, please refer
 to this `section <Contributing.rst>`__.
 
-8. Changelog
+Changelog
 ------------
 
 Find the changelog `here <CHANGELOG.md>`__
 
-9. License
+License
 ----------
 
 `GPLv3 <https://choosealicense.com/licenses/gpl-3.0/>`__
 
-10. History and project status
+History and project status
 ------------------------------
 
 This project was initially written in matlab using FEMM simulation tool.

setup.py

@@ -61,7 +61,7 @@
         "Documentation": "https://upb-lea.github.io/FEM_Magnetics_Toolbox/main/intro.html",
         "Source Code": "https://github.com/upb-lea/FEM_Magnetics_Toolbox",
     },
-    version='0.2.1',
+    version='0.3.0',
     zip_safe=False,
     data_files=[('', ['CHANGELOG.md'])]
 )

sphinx/source/conf.py

@@ -23,7 +23,7 @@
 author = 'LEA-UPB'
 
 # The full version, including alpha/beta/rc tags
-release = '0.2.1'
+release = '0.3.0'
 
 # -- General configuration ---------------------------------------------------
 
@@ -66,9 +66,6 @@
     'collapse_navigation': False,
 }
 
-# replace "view page source" with "edit on github" in Read The Docs theme
-#  * https://github.com/readthedocs/sphinx_rtd_theme/issues/529
-
 html_context = {
     'display_github': True,
     'github_user': 'upb-lea',

sphinx/source/femmt.rst

@@ -1,24 +1,15 @@
-.. FEM Magnetics Toolbox documentation master file, created by
-   sphinx-quickstart on Fri Oct 15 16:52:09 2021.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Welcome to FEM Magnetics Toolbox's documentation!
-=================================================
+"""""""""""""""""""""""""""""""""""""""""""""""""""""
 
 .. toctree::
    :maxdepth: 6
-   :caption: Contents:
+   :caption: Table of Contents:
 
    intro
-   femmt
-
-
 
 
 Indices and tables
-==================
+"""""""""""""""""""""""""""""""""""""""""""""""""""""
 
 * :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+

sphinx/source/index.rst

@@ -1,37 +1,34 @@
 .. sectnum::
 
-************
-Introduction
-************
-==============================
- FEM Magnetics Toolbox (FEMMT)
-==============================
-Python toolbox to generate preconfigured figures for FEM simulation tools in power electronics.
 
-The toolbox contains two parts, a reluctance module and a FEM module.
- * The reluctance module is for pre-calculations
- * The FEM module is for detailed calculations
+.. include:: ../../README.rst
 
-The toolbox is accessible via python code or a graphical user interface (GUI), which current development status is experimental.
 
-.. image:: ../../documentation/femmt.png
-    :width: 300px
-    :align: center
-    :alt: femmt overview
+Function and class documentation
+==================================
+The ``MagneticComponent`` class
+----------------------------------
 
-Functionality examples
-    * work with pre-defined standard core structures
-    * work with pre-defined litz wires
-    * use python to perform parametersweeps, e.g. perform several automated simulations of different air gap sizes
-    * read the results automated with python from the FEM simulation tool
+.. currentmodule:: femmt.femmt_classes
 
-.. note::
-      Development status: Alpha
-          * GUI is experimental,
-          * reluctance module is currently working for a single optimization example and not fully implemented yet.
+.. autoclass:: MagneticComponent
+   :members:
+   :undoc-members:
+   :special-members: __init__
+   :member-order: bysource
 
-.. include:: install.rst
+FEMMT functions
+---------------------------------
 
-.. include:: usage.rst
+.. automodule:: femmt.femmt_functions
+    :members:
+    :undoc-members:
+  
+FEMMT Thermal
+-------------------------
 
-.. include:: others.rst
+.. currentmodule:: femmt.thermal.thermal_classes
+
+.. autoclass:: ConstraintPro
+    :members:
+    :undoc-members: