aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAdam Spiers <git@adamspiers.org>2018-05-16 20:15:36 +0100
committerAdam Spiers <git@adamspiers.org>2018-05-16 20:15:36 +0100
commitc3b19c25b9053e262a3ba3e9f5d7d01216003ccc (patch)
tree3aea8f932e5eebc35236f793933422146d6bf22d /docs
parent2335d33a8105013ac60091608eeef72c21719761 (diff)
downloadgit-deps-c3b19c25b9053e262a3ba3e9f5d7d01216003ccc.tar.gz
add some stub Sphinx documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst28
1 files changed, 6 insertions, 22 deletions
diff --git a/docs/index.rst b/docs/index.rst
index be83b1b..2bb0282 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -2,28 +2,12 @@
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``.
+This will become the main documentation of **git-deps**.
+
+Unfortunately it hasn't been written yet, but in the mean time there
+is plenty of useful information on `the GitHub project
+<https://github.com/aspiers/git-deps/>`_
+
Contents
========