Merge pull request #176 from fast-aircraft-design/doc-update

Updated documentation

CHANGELOG.rst

@@ -2,7 +2,13 @@
 Changelog
 =========
 
-Version 0.1a
-=============
+Version 0.2.0b
+==============
+
+- First beta release
+
+
+Version 0.1.0a
+==============
 
 - First alpha release

README.md

@@ -25,7 +25,9 @@ Install
 -------
 
 **Prerequisite**:FAST-OAD needs at least **Python 3.6.1** (usage of
-**Python 3.8.**\* is discouraged as Jupyter notebooks are still [not
+**Python 3.8.**\* is discouraged on Windows: some additional features of
+ FAST-OAD require Jupyter notebooks, which are for now
+ [not
 compatible with
 it](https://github.com/jupyterlab/jupyterlab/issues/6487)).
 

docs/documentation/install.rst

@@ -3,7 +3,10 @@
 ######################
 Installation procedure
 ######################
-**Prerequisite**:FAST-OAD needs at least **Python 3.6.1** (usage of **Python 3.8.*** is discouraged as Jupyter notebooks are still `not compatible with it <https://github.com/jupyterlab/jupyterlab/issues/6487>`_).
+**Prerequisite**:FAST-OAD needs at least **Python 3.6.1** (usage of **Python 3.8.***
+is discouraged on Windows: some additional features of FAST-OAD require Jupyter notebooks,
+which are for now
+`not compatible with it <https://github.com/jupyterlab/jupyterlab/issues/6487>`_).
 
 It is recommended (but not required) to install FAST-OAD in a virtual environment (`conda <https://docs.conda.io/en/latest/>`_, `venv <https://docs.python.org/3.7/library/venv.html>`_...)
 

docs/documentation/overview.rst

@@ -1,4 +1,4 @@
-.. _usage:
+.. _overview:
 
 #################
 FAST-OAD overview

docs/index.rst

@@ -6,12 +6,18 @@ This is the documentation of **FAST-OAD**.
 
 .. note::
 
-    Still a work in progress
+    For a quick overview of the way FAST-OAD works, please go :ref:`here<overview>`.
 
-    You may go directly to the :ref:`OpenMDAO models<fastoad.models package>`
+    For a detailed description of the input files and the command line interface,
+    check out the :ref:`usage section<usage>`.
 
-    To get an OpenMDAO problem that interacts with the FAST-OAD configuration file, please see
-    the :ref:`FASTOADProblem class<fastoad.io.configuration.configuration module>`
+    If you prefer to work with Python notebooks, you may go directly to the section 
+    :ref:`python-usage`.
+
+    For a description of models used in FAST-OAD, you may see the
+    :ref:`model documentations<fastoad.models package>` (still a work in progress).
+
+    To see how you can add your own models, go :ref:`here<add-modules>`.
 
 Contents
 ========

docs/refs.bib

@@ -14,14 +14,6 @@ @phdthesis{roux:2005
     url = {http://depozit.isae.fr/theses/2005/2005_Roux_Elodie.pdf},
 }
 
-@book{raymer:1992,
-    author = {Raymer, Daniel P.},
-    title = {Aircraft Design: A Conceptual Approach, Second edition},
-    year = {1992},
-    isbn = {0930403517},
-    publisher = {AIAA (American Institute of Aeronautics \& Astronautics},
-}
-
 @book{raymer:1999,
     author = {Raymer, Daniel P.},
     title = {Aircraft Design: A Conceptual Approach, Third edition},
@@ -30,16 +22,6 @@ @book{raymer:1999
     publisher = {AIAA (American Institute of Aeronautics \& Astronautics},
 }
 
-@book{torenbeek:2013,
-    author = {Torenbeek, Egbert},
-    isbn = {9781118568101},
-    publisher = {John Wiley and Sons},
-    series = {Aerospace Series},
-    timestamp = {2014-08-11T15:20:49.000+0200},
-    title = {Advanced Aircraft Design : Conceptual Design, Analysis and Optimization of Subsonic Civil Airplanes},
-    year = {2013}
-}
-
 @misc{kroo:2001,
     url={https://web.archive.org/web/20010307121417/http://adg.stanford.edu/aa241/propulsion/nacelledesign.html},
     year = {2001}