Merge pull request #28 from jorgepiloto/docs

With this, docs are updated 😄 Before closing #3 I would like to include more examples in a future pull request 😄

README.rst

@@ -1,12 +1,35 @@
-scikit-aero
-===========
+.. image:: doc/source/_static/logo.png
+        :align: center
+
+.. image:: https://img.shields.io/maintenance/yes/2019.svg?style=for-the-badge
+	:target: https://github.com/AeroPython/scikit-aero
+	:alt: Maintenance
+
+.. image:: https://img.shields.io/pypi/l/scikit-aero.svg?style=for-the-badge
+        :target: https://github.com/AeroPython/scikit-aero/blob/master/COPYING
+        :alt: License
+
+.. image:: https://readthedocs.org/projects/pip/badge/?version=latest&style=for-the-badge
+        :target: https://aeropython.github.io/scikit-aero/
+        :alt: Docs
+
+.. image:: https://img.shields.io/badge/mailing%20list-groups.io-8cbcd1.svg?style=for-the-badge
+        :target: [email protected]
+        :alt: Email
+
+|
 
 :Name: scikit-aero
 :Description: Aeronautical engineering calculations in Python
 :Website: https://github.com/AeroPython/scikit-aero
 :Author: AeroPython Team <[email protected]>
 :Version: 0.2.dev0
 
+|
+
+Scikit-aero
+-----------
+
 scikit-aero is a Python package for various aeronautical engineering
 calculations. It is based on several existing Python packages on the field,
 but intends to provide pythonic syntax, use of SI units and full NumPy arrays
@@ -41,23 +64,29 @@ Future
 Usage
 =====
 
-Atmosphere properties::
+Atmosphere properties:
+
+.. code-block:: python
 
-  >>> from skaero.atmosphere import coesa
-  >>> h, T, p, rho = coesa.table(1000)  # Altitude by default, 1 km
+        from skaero.atmosphere import coesa
+        h, T, p, rho = coesa.table(1000)  # Altitude by default, 1 km
 
-Inverse computations allowed with density and pressure, which are monotonic::
+Inverse computations allowed with density and pressure, which are monotonic:
 
-  >>> h, T, p, rho = coesa.table(p=101325)  # Pressure of 1 atm
+.. code-block:: python
 
-Gas dynamics calculations::
+        h, T, p, rho = coesa.table(p=101325)  # Pressure of 1 atm
 
-  >>> from skaero.gasdynamics import isentropic, shocks
-  >>> fl = isentropic.IsentropicFlow(gamma=1.4)
-  >>> p = 101325 * fl.p_p0(M=0.8)  # Static pressure given total pressure of 1 atm
-  >>> ns = shocks.Shock(M_1=2.5, gamma=1.4)
-  >>> M_2 = ns.M_2  # Mach number behind a normal shock wave
-  >>> os = shocks.Shock(M_1=3.0, theta=np.radians(25), weak=True)
+Gas dynamics calculations:
+
+.. code-block:: python
+
+        from skaero.gasdynamics import isentropic, shocks
+        fl = isentropic.IsentropicFlow(gamma=1.4)
+        p = 101325 * fl.p_p0(M=0.8)  # Static pressure given total pressure of 1 atm
+        ns = shocks.Shock(M_1=2.5, gamma=1.4)
+        M_2 = ns.M_2  # Mach number behind a normal shock wave
+        os = shocks.Shock(M_1=3.0, theta=np.radians(25), weak=True)
 
 Dependencies
 ============
@@ -87,9 +116,17 @@ version of IPython and its dependencies.
 Install
 =======
 
-This package uses distutils. To install, execute as usual::
+To install just execute:
+
+.. code-block:: bash
+
+        $ pip install scikit-aero
 
-  $ python setup.py install
+If you want to install the package in development mode, please execute:
+
+.. code-block:: bash
+
+        $ pip install --editable /path_to_scikit-aero
 
 It is recommended that you **never ever use sudo** with distutils, pip,
 setuptools and friends in Linux because you might seriously break your
@@ -109,13 +146,17 @@ Testing
 =======
 
 scikit-aero recommends py.test for running the test suite. Running from the
-top directory::
+top directory:
+
+.. code-block:: bash
+
+        $ pytest
 
-  $ py.test
+To test code coverage, make sure you install `py.test-cov`_ extension and run:
 
-To test code coverage, make sure you install `py.test-cov`_ extension and run::
+.. code-block:: bash
 
-  $ py.test --cov skaero/
+        $ pytest --cov skaero/
 
 .. _`py.test-cov`: https://pypi.python.org/pypi/pytest-cov
 

doc/source/about_skaero.rst

@@ -0,0 +1,50 @@
+About skaero
+============
+
+The package collects different algorithms that solve for classical aeronautical
+or aerospace problems such us finding the isentropic relations for a given Mach
+number, atmospheric properties for a given altitude and many others.
+
+History
+-------
+
+.. _Juan Luis Cano: https://github.com/Juanlu001
+.. _Guilles Aouizerate: https://github.com/Gillu13
+.. _Javier J. Gutiérrez: https://github.com/javierj
+.. _Jorge Martínez: https://github.com/jorgepiloto
+
+The project was started by `Juan Luis Cano`_. With the contribution of
+`Guilles Aouizerate`_ and `Javier J. Gutiérrez`_ more implementations to the
+package were done such us tests implementation and extension of the COESA model
+up to 86km.
+
+After some time, the project was no longer mantained till `Jorge Martínez`_
+started working again on `skaero`: a Python package for aeronautical and
+aerospace computations.
+
+Related Software
+----------------
+
+.. _AeroCalc: https://pypi.org/project/AeroCalc/0.11/
+.. _Matlab Aerospace Toolbox: www.mathworks.com/help/aerotbx/index.html
+.. _PDAS: http://www.pdas.com/index.html
+
+Many different softwares that enable the user to make similar computations are
+listed down:
+
+- `AeroCalc`_
+- `Matlab Aerospace Toolbox`_
+- `PDAS`_
+
+In future versions
+------------------
+
+We are still working in this software and therefore issues and pull requests are
+welcome. Some ideas for the moment are:
+
+- Improve project documentation
+- Implement GOST russian atmosphere
+- Include more examples on how to use the package
+
+Please, take a look to the official repository in GitHub if you want to make
+a contribution to the project.

doc/source/conf.py

@@ -27,11 +27,11 @@
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = [
     'sphinx.ext.autodoc',
-    'sphinx.ext.doctest',
+    'sphinx.ext.napoleon',
     'sphinx.ext.todo',
-    'sphinx.ext.coverage',
     'sphinx.ext.mathjax',
-    'sphinx.ext.viewcode']
+    'sphinx.ext.intersphinx',
+    'nbsphinx']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -97,7 +97,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'solar'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

doc/source/examples/index.rst

@@ -0,0 +1,12 @@
+Examples
+========
+
+Different examples on how to use `skaero` have been implemented in the following
+Jupyter Notebook files. If you have more examples on how to use this package,
+please start a pull request in the official repository.
+
+.. toctree::
+   :maxdepth: 1
+
+   Convergent-divergent nozzle.ipynb
+   Oblique shocks chart.ipynb

doc/source/index.rst

@@ -1,21 +1,23 @@
-scikit-aero
-===========
+.. image:: _static/logo.png
+        :align: center
+
+|
+
+What is **scikit-aero**?
+========================
 
 **scikit-aero** is a Python package for various aeronautical engineering
 calculations. It is based on several existing Python packages on the field,
 but intends to provide pythonic syntax, use of SI units and full NumPy arrays
 support among other things. scikit-aero is licensed under the BSD license.
 
+
 Contents:
 
 .. toctree::
    :maxdepth: 2
 
-   api
-
-Indices and tables
-==================
+   about_skaero
+   examples/index
+   skaero/index
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

doc/source/skaero/atmosphere/index.rst

@@ -0,0 +1,13 @@
+Atmosphere module
+=================
+
+The atmosphere modeled by **scikit-aero** follows the U.S. Committee on
+Extension to the Standard Atmosphere (COESA), also known as U.S Standard
+Atmosphere 1976.
+
+This atmosphere rotates with the Earth. The air is assumed to follow all the
+laws for perfect gas and the hydrostatics equations. Therefore a realation
+between temperature, pressure and density can be stablished with geopotential.
+
+.. automodule:: skaero.atmosphere.coesa
+   :members:

doc/source/skaero/gasdynamics/index.rst

@@ -0,0 +1,14 @@
+Gas dynamics
+============
+
+This module holds different submodules related to gas dynamics, in particular
+with ideal flow computations.
+
+.. toctree::
+   :maxdepth: 2
+
+   isentropic
+   nozzles
+   shocks
+
+

doc/source/skaero/gasdynamics/isentropic.rst

@@ -0,0 +1,9 @@
+Isentropic
+==========
+
+This submodule holds the class `IdealFlow` and `PrandtlMeyerExpansion`, since
+both of them are considered under the study of ideal flow dynamics.
+
+.. automodule:: skaero.gasdynamics.isentropic
+   :members:
+

doc/source/skaero/gasdynamics/nozzles.rst

@@ -0,0 +1,5 @@
+Nozzles
+=======
+
+.. automodule:: skaero.gasdynamics.nozzles
+   :members:

doc/source/skaero/gasdynamics/shocks.rst

@@ -0,0 +1,5 @@
+Shocks
+======
+
+.. automodule:: skaero.gasdynamics.shocks
+   :members:

doc/source/skaero/geometry/index.rst

@@ -0,0 +1,5 @@
+Geometry Module
+===============
+
+.. automodule:: skaero.geometry.joukowsky
+   :members:

doc/source/skaero/index.rst

@@ -0,0 +1,11 @@
+API skaero
+==========
+
+All the modules that `skaero` contains are listed down. 
+
+.. toctree::
+   :maxdepth: 2
+
+   atmosphere/index
+   gasdynamics/index
+   geometry/index