Merge pull request #167 from GAA-UAM/feature/documentation-index

Improvements in documentation index

README.rst

@@ -44,22 +44,18 @@ Installation from source
 It is possible to install the latest version of the package, available in the
 develop branch,  by cloning this repository and doing a manual installation.
 
-.. code::
+.. code:: bash
 
     git clone https://github.com/GAA-UAM/scikit-fda.git
-    cd scikit-fda/
-    pip install -r requirements.txt    # Install dependencies
-    python setup.py install
+    pip install ./scikit-fda
 
 Make sure that your default Python version is currently supported, or change
 the python and pip commands by specifying a version, such as ``python3.6``:
 
-.. code::
+.. code:: bash
 
     git clone https://github.com/GAA-UAM/scikit-fda.git
-    cd scikit-fda/
-    python3.6 -m pip install -r requirements.txt    # Install dependencies
-    python3.6 setup.py install
+    python3.6 -m pip install ./scikit-fda
 
 Requirements
 ------------
@@ -88,11 +84,11 @@ The people involved at some point in the development of the package can be
 found in the `contributors
 file <https://github.com/GAA-UAM/scikit-fda/blob/develop/THANKS.txt>`_.
 
-Citation
-========
-If you find this project useful, please cite:
+.. Citation
+   ========
+   If you find this project useful, please cite:
 
-.. todo:: Include citation to scikit-fda paper.
+   .. todo:: Include citation to scikit-fda paper.
 
 License
 =======

docs/conf.py

@@ -17,9 +17,6 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, '/home/miguel/Desktop/fda/fda')
 
 import os
 import sys
@@ -79,7 +76,8 @@
 
 # General information about the project.
 project = 'scikit-fda'
-copyright = '2017, Author'
+copyright = ('2019, Grupo de Aprendizaje Automático - ' +
+             'Universidad Autónoma de Madrid')
 author = 'Author'
 
 # The language for content autogenerated by Sphinx. Refer to documentation

docs/index.rst

@@ -5,18 +5,78 @@
 Welcome to scikit-fda's documentation!
 ======================================
 
+This package offers classes, methods and functions to give support to
+Functional Data Analysis in Python. Includes a wide range of utils to work with
+functional data, and its representation, exploratory analysis, or
+preprocessing, among other tasks such as inference, classification, regression
+or clustering of functional data.
+
+In the `project page <https://github.com/GAA-UAM/scikit-fda>`_ hosted by
+Github you can find more information related to the development of the package.
+
+
 .. toctree::
-   :includehidden:
-   :maxdepth: 4
+   :maxdepth: 2
    :caption: Contents:
    :titlesonly:
 
    apilist
+
+
+.. toctree::
+   :maxdepth: 1
+   :titlesonly:
+
    auto_examples/index
 
-Indices and tables
-==================
+An exhaustive list of all the contents of the package can be found in the
+:ref:`genindex`.
+
+Installation
+------------
+
+Currently, scikit-fda is available in Python 3.6 and 3.7, regardless of the
+platform. The stable version can be installed via
+`PyPI <https://pypi.org/project/scikit-fda/>`_:
+
+.. code-block:: bash
+
+   pip install scikit-fda
+
+
+It is possible to install the latest version of the package, available in
+the develop branch, by cloning this repository and doing a manual installation.
+
+.. code-block:: bash
+
+   git clone https://github.com/GAA-UAM/scikit-fda.git
+   pip install ./scikit-fda
+
+
+In this type of installation make sure that your default Python version is
+currently supported, or change the python and pip commands by specifying a
+version, such as python3.6.
+
+
+Contributions
+-------------
+
+All contributions are welcome. You can help this project grow in multiple ways,
+from creating an issue, reporting an improvement or a bug, to doing a
+repository fork and creating a pull request to the development branch.
+The people involved at some point in the development of the package can be
+found in the `contributors file
+<https://github.com/GAA-UAM/scikit-fda/blob/develop/THANKS.txt>`_.
+
+.. Citation
+   --------
+   If you find this project useful, please cite:
+
+   .. todo:: Include citation to scikit-fda paper.
+
+License
+-------
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+The package is licensed under the BSD 3-Clause License. A copy of the
+`license <https://github.com/GAA-UAM/scikit-fda/blob/develop/LICENSE.txt>`_
+can be found along with the code or in the project page.