.. splinart documentation master file, created by
   sphinx-quickstart on Fri Nov 17 10:27:27 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to splinart's documentation!
====================================

splinart is a package used for a tutorial which explains how to do the Python packaging using

- `PyPi <https://pypi.python.org/pypi>`_
- `conda build <https://conda.io/docs/user-guide/tasks/build-packages/recipe.html>`_
- `pytest <https://docs.pytest.org/en/latest/>`_
- `Pylint <https://www.pylint.org/>`_
- `Sphinx <http://www.sphinx-doc.org/en/stable/>`_

And automate the process to distribute this package using github.

The original idea of splinart is found on the great invonvergent website.

If you want to install splinart::

    pip install splpinart

or::

    conda install -c gouarin splinart

User manual
===========
.. toctree::
    :maxdepth: 2

    spline

Tutorial
========
.. toctree::
    :maxdepth: 2

    notebooks/circle

Reference manual
================

.. toctree::
    :maxdepth: 2

    api/modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`