Add deployment via Travis (#172)

.travis.yml

@@ -57,3 +57,13 @@ after_success:
           codecov
           echo 'send coverage statistic'
       fi
+
+deploy:
+    provider: pypi
+    user: peisenha
+    password:
+        secure: R41aRCGRdv9836NuKDHK4zcP5EjdUVpsMeJr+sTsdGT6Q9zALvBZJ5fMavmPL+Ufp/e+11AFZwJeujNm08gMNPgyBOwx4Z1Oa/zFWBt6Sz3NIXmarfbfoOzKR+GVf/BJXlnZiNOy7yaMFmt1JOQ8fH29mk2CxEQtyogrjKRfiVYgFN4W54uI5gpTQQ8jZVO3yHiQ+YEaiA9u3AX2kuqqW6A2yPD+tuffuMYfoshz3/rVFh/TjUwk8gaXCj/RgW8nz+QGVoSfYokLKSs4h5YqtCYglEflIuxWITZ/gwkFsOPrwdm25kkcLEP/GuO5fqdDjzLbqQhRrCUZc9rJYdWFwzyHS9/N8uF8DCH8Dn67SVLGim+wT4kc2jXfND1k/dh4kjqgCQQpGMQSX1dxJdPZnNc1kvwm84YTXL91sG4Zu87fSHawChxNY23zuqNiJDZbvQ12anoHciFJinKVTp6CtAiZhcatoJ1nk8c+d27rSh+i3oly6N6tyWekZXMpngd44xVPCz4VrByyUAZlezODg2QLA05+4KOPSgAySHHeR7/QFbSkupGs0DvM0yxVjkMHerAvHDfQUm53yvHDnBM2kVhxISzA48HByi0dETAicZCw5Uh65oaZAfAnBDrV/Vuawe1AUCJobVue1Gbh6ycI53x9MKwCjJDJFiONFqr5HfE=
+    distributions: "sdist"
+    on:
+        tags: true
+        condition: "$CI_FORTRAN = False"

CHANGES.rst

@@ -0,0 +1,24 @@
+Changes
+=======
+
+This is a record of all past ``respy`` releases and what went into them in reverse
+chronological order. We follow `semantic versioning <https://semver.org/>`_ and all
+releases are available on `PyPI <https://pypi.org/project/respy/>`_.
+
+2.0.0 - 2019-
+-------------
+
+- `#162 <https://github.com/OpenSourceEconomics/respy/pull/162>`_ is a wrapper around
+  multiple PRs in which a new Python version is implemented.
+- `#150 <https://github.com/OpenSourceEconomics/respy/pull/150>`_ implements a new
+  interface.
+- `#133 <https://github.com/OpenSourceEconomics/respy/pull/133>`_ and `#140
+  <https://github.com/OpenSourceEconomics/respy/pull/140>`_ add Appveyor to test respy
+  on Windows.
+- `#67 <https://github.com/OpenSourceEconomics/respy/pull/67>`_ removes everything
+  related to ambiguity.
+
+1.0.0 - 2016-09-01
+------------------
+
+This is the initial release of the ``respy`` package.

docs/api.rst

@@ -0,0 +1,7 @@
+API
+===
+
+The API provides detailed descriptions of ``respy`` classes and functions. It
+should be helpful if you plan to extend ``respy`` with custom components.
+
+.. autoclass:: respy.clsRespy.RespyCls

docs/bibliography.rst

@@ -11,7 +11,7 @@ Choice Programming Models. *Unpublished Manuscript*.
 
 Eisenhauer, P. (2016). `The Approximate Solution of Finite-Horizon Discrete Choice
 Dynamic Programming Models: Revisiting Keane & Wolpin (1994)
-<https://github.com/structRecomputation/manuscript/blob/master/eisenhauer.2016.pdff>`_.
+<https://github.com/structRecomputation/manuscript/blob/master/eisenhauer.2016.pdf>`_.
 *Unpublished Manuscript*.
 
 Eisenhauer, P. (2016b). Risk and Ambiguity in Dynamic Models of Educational Choice.

docs/changes.rst

@@ -1,28 +1 @@
-Changes
-=======
-
-This is a record of all past ``respy`` releases and what went into them in reverse
-chronological order. We follow `semantic versioning <https://semver.org/>`_ and all
-releases are available on `PyPI <https://pypi.org/project/respy/>`_.
-
-.. todo::
-
-    Add more information on version changes.
-
-2.0.0 - 2019-
--------------
-
-- `#162 <https://github.com/OpenSourceEconomics/respy/pull/162>`_ is a wrapper around
-  multiple PRs in which a new Python version is implemented.
-- `#150 <https://github.com/OpenSourceEconomics/respy/pull/150>`_ implements a new
-  interface.
-- `#133 <https://github.com/OpenSourceEconomics/respy/pull/133>`_ and `#140
-  <https://github.com/OpenSourceEconomics/respy/pull/140>`_ add Appveyor to test respy
-  on Windows.
-- `#67 <https://github.com/OpenSourceEconomics/respy/pull/67>`_ removes everything
-  related to ambiguity.
-
-1.0.0 - 2016-09-01
-------------------
-
-This is the initial release of the ``respy`` package.
+.. include:: ../CHANGES.rst

docs/index.rst

@@ -45,6 +45,16 @@ baseline model presented in:
    scalability
    software_engineering
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Development
+   :hidden:
+
+   developer_doc
+   docker
+   releases
+   api
+
 .. toctree::
    :maxdepth: 1
    :caption: Additional Information

docs/releases.rst

@@ -0,0 +1,45 @@
+Releases
+========
+
+What is the new version number?
+-------------------------------
+
+The version number depends on the severity of the changes and adheres to `semantic
+versioning <https://semver.org/>`_.
+
+You are also allowed to append ``rc1`` after the last digit to indicate the first or
+higher release candidates. By that, you can test the release and deployment on PyPI and
+release preliminary versions.
+
+
+How to release a new version?
+-----------------------------
+
+1. At first, we need to create a new PR to prepare everything for the new version. We
+   need to
+
+   - update all mentions of the old version number
+   - update information in ``CHANGES.rst`` to have summary of the changes which
+     can also be posted in the Github repository under the tag.
+
+2. After the PR is merged into master, go to the master branch in your local repository
+   and pull the latest changes. Make sure that the current tip of the branch corresponds
+   to the state where you want to set the new version. Then, type
+
+   .. code-block:: bash
+
+       $ git tag -m "x.x.x"
+
+   to create a tag with the version number. After that, you need to push the tag to the
+   remote repository which triggers a Travis-CI build and deployment to PyPI.
+
+   .. code-block:: bash
+
+       $ git push --tags
+
+3. Make sure that the new release was indeed published by checking `PyPI
+   <https://pypi.org/project/respy/>`_. Also, copy the information from the new release
+   in ``CHANGES.rst`` and post it under the `new release
+   <https://github.com/OpenSourceEconomics/respy/releases/>`_.
+
+4. Spread the word!

tox.ini

@@ -64,7 +64,9 @@ markers =
 norecursedirs =
     respy/*waf*
     respy/.bld
-    doc
+    respy/scripts
+    development
+    docs
     .tox
 filterwarnings =
     ignore:`formatargspec` is deprecated