From a0de069317e19c456f55b3746747312be7a167cc Mon Sep 17 00:00:00 2001 From: pablomm Date: Sat, 21 Sep 2019 15:17:47 +0200 Subject: [PATCH 1/3] Improvements in documentation index. * Add information in the index, and best presentation * Remove old index broken links * Update copyright in conf.py according to the current license --- docs/conf.py | 6 ++-- docs/index.rst | 77 +++++++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 72 insertions(+), 11 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 18a8d6170..177af1566 100644 --- a/docs/conf.py +++ b/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 diff --git a/docs/index.rst b/docs/index.rst index f5f999aff..a8aedd176 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -5,18 +5,81 @@ 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 `_ 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 `_: + +.. 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 + cd scikit-fda/ + pip install -r requirements.txt + python setup.py install + + +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 +`_. + +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 `_ +can be found along with the code or in the project page. From ffcb066517b4b9076454f8dd6795ab848513fba9 Mon Sep 17 00:00:00 2001 From: pablomm Date: Mon, 23 Sep 2019 17:29:39 +0200 Subject: [PATCH 2/3] Remove paper section --- README.rst | 8 ++++---- docs/index.rst | 9 ++++----- 2 files changed, 8 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 07a5a7017..c83e56535 100644 --- a/README.rst +++ b/README.rst @@ -88,11 +88,11 @@ The people involved at some point in the development of the package can be found in the `contributors file `_. -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 ======= diff --git a/docs/index.rst b/docs/index.rst index a8aedd176..a3ecf34e1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -70,12 +70,11 @@ The people involved at some point in the development of the package can be found in the `contributors file `_. -Citation --------- +.. Citation + -------- + If you find this project useful, please cite: -If you find this project useful, please cite: - -.. todo:: Include citation to scikit-fda paper. + .. todo:: Include citation to scikit-fda paper. License ------- From 11f908160c8c79569a54d6abab2151d740dca810 Mon Sep 17 00:00:00 2001 From: pablomm Date: Mon, 23 Sep 2019 17:58:14 +0200 Subject: [PATCH 3/3] Change installation command --- README.rst | 12 ++++-------- docs/index.rst | 4 +--- 2 files changed, 5 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index c83e56535..757866897 100644 --- a/README.rst +++ b/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 ------------ diff --git a/docs/index.rst b/docs/index.rst index a3ecf34e1..f451e872b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -50,9 +50,7 @@ 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 - cd scikit-fda/ - pip install -r requirements.txt - python setup.py install + pip install ./scikit-fda In this type of installation make sure that your default Python version is