Update documentation

Author: SylvainCorlay

docs/source/api_reference.rst

@@ -8,5 +8,7 @@ API reference
 =============
 
 .. toctree::
+   :maxdepth: 2
 
    pyarray
+   pytensor

docs/source/basic_usage.rst

@@ -21,15 +21,17 @@ Example 1: Use an algorithm of the C++ library on a numpy array inplace
 
     double sum_of_sines(xt::pyarray<double> &m)
     {
-        auto sines = xt::sin(m);  // sines does not actually hold any value, which are only computed upon access
+        auto sines = xt::sin(m);
+        // sines does not actually hold any value, which are only computed upon access
         return std::accumulate(sines.begin(), sines.end(), 0.0);
     }
 
     PYBIND11_PLUGIN(xtensor_python_test)
     {
         pybind11::module m("xtensor_python_test", "Test module for xtensor python bindings");
 
-        m.def("sum_of_sines", sum_of_sines, "Computes the sum of the sines of the values of the input array");
+        m.def("sum_of_sines", sum_of_sines,
+            "Computes the sum of the sines of the values of the input array");
 
         return m.ptr();
     }

docs/source/cookie_cutter.rst

@@ -28,7 +28,7 @@ Install cookiecutter_
 
     pip install cookiecutter
 
-After installing cookiecutter, use the xtensor-cookiecutter_:
+After installing cookiecutter, use the xtensor_cookiecutter_:
 
 .. code::
 
@@ -50,5 +50,5 @@ This will produce a directory containing all the required content for a minimal
 project making use of xtensor with all the required boilerplate for package management,
 together with a few basic examples.
 
-.. _xtensor-cookicutter: https://github.com/QuantStack/xtensor-cookiecutter
+.. _xtensor_cookicutter: https://github.com/QuantStack/xtensor-cookiecutter
 .. _cookiecutter: https://github.com/audreyr/cookiecutter

docs/source/index.rst

@@ -63,6 +63,11 @@ This software is licensed under the BSD-3-Clause license. See the LICENSE file f
 
    api_reference
 
+.. toctree::
+   :caption: DEVELOPER ZONE
+
+   releasing
+
 .. _NumPy: http://www.numpy.org
 .. _`Buffer Protocol`: https://docs.python.org/3/c-api/buffer.html
 .. _xtensor: https://github.com/QuantStack/xtensor

docs/source/pytensor.rst

@@ -0,0 +1,12 @@
+.. Copyright (c) 2016, Johan Mabille and Sylvain Corlay
+
+   Distributed under the terms of the BSD 3-Clause License.
+
+   The full license is in the file LICENSE, distributed with this software.
+
+pytensor
+========
+
+.. doxygenclass:: xt::pytensor
+   :project: xtensor-python
+   :members:

docs/source/releasing.rst

@@ -0,0 +1,30 @@
+.. Copyright (c) 2016, Johan Mabille and Sylvain Corlay
+
+   Distributed under the terms of the BSD 3-Clause License.
+
+   The full license is in the file LICENSE, distributed with this software.
+
+Releasing xtensor-python
+========================
+
+Releasing a new version
+-----------------------
+
+From the master branch of xtensor-python
+
+- Make sure that you are in sync with the master branch of the upstream remote.
+- In file ``xtensor_python_config.hpp``, set the macros for ``XTENSOR_PYTHON_VERSION_MAJOR``, ``XTENSOR_PYTHON_VERSION_MINOR`` and ``XTENSOR_PYTHON_VERSION_PATCH`` to the desired values.
+- Update the readme file w.r.t. dependencies on xtensor and pybind11.
+- Stage the changes (``git add``), commit the changes (``git commit``) and add a tag of the form ``Major.minor.patch``. It is important to not add any other content to the tag name.
+- Push the new commit and tag to the main repository. (``git push``, and ``git push --tags``)
+
+Updating the conda-forge recipe
+-------------------------------
+
+xtensor-python has been packaged for the conda package manager. Once the new tag has been pushed on GitHub, edit the conda-forge recipe for xtensor in the following fashion:
+
+- Update the version number to the new Major.minor.patch.
+- Set the build number to 0.
+- Update the hash of the source tarball.
+- Check for the versions of the dependencies.
+- Optionally, rerender the conda-forge feedstock.