aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
blob: be83b1b400fcbdfb21b87018113b85c48f5a3489 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
========
git-deps
========

This is the documentation of **git-deps**.

.. note::

    This is the main page of your project's `Sphinx <http://sphinx-doc.org/>`_
    documentation. It is formatted in `reStructuredText
    <http://sphinx-doc.org/rest.html>`__. Add additional pages by creating
    rst-files in ``docs`` and adding them to the `toctree
    <http://sphinx-doc.org/markup/toctree.html>`_ below. Use then
    `references <http://sphinx-doc.org/markup/inline.html>`__ in order to link
    them from this page, e.g. :ref:`authors <authors>` and :ref:`changes`.
    It is also possible to refer to the documentation of other Python packages
    with the `Python domain syntax
    <http://sphinx-doc.org/domains.html#the-python-domain>`__. By default you
    can reference the documentation of `Sphinx <http://sphinx.pocoo.org>`__,
    `Python <http://docs.python.org/>`__, `matplotlib
    <http://matplotlib.sourceforge.net>`__, `NumPy
    <http://docs.scipy.org/doc/numpy>`__, `Scikit-Learn
    <http://scikit-learn.org/stable>`__, `Pandas
    <http://pandas.pydata.org/pandas-docs/stable>`__, `SciPy
    <http://docs.scipy.org/doc/scipy/reference/>`__. You can add more by
    extending the ``intersphinx_mapping`` in your Sphinx's ``conf.py``.

Contents
========

.. toctree::
   :maxdepth: 2

   License <license>
   Authors <authors>
   Changelog <changes>
   Module Reference <api/modules>


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

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