aboutsummaryrefslogtreecommitdiffstats
path: root/docs/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 0000000..62a305d
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,45 @@
1=================
2youtube-podcaster
3=================
4
5This is the documentation of **youtube-podcaster**.
6
7.. note::
8
9 This is the main page of your project's `Sphinx <http://sphinx-doc.org/>`_
10 documentation. It is formatted in `reStructuredText
11 <http://sphinx-doc.org/rest.html>`__. Add additional pages by creating
12 rst-files in ``docs`` and adding them to the `toctree
13 <http://sphinx-doc.org/markup/toctree.html>`_ below. Use then
14 `references <http://sphinx-doc.org/markup/inline.html>`__ in order to link
15 them from this page, e.g. :ref:`authors <authors>` and :ref:`changes`.
16 It is also possible to refer to the documentation of other Python packages
17 with the `Python domain syntax
18 <http://sphinx-doc.org/domains.html#the-python-domain>`__. By default you
19 can reference the documentation of `Sphinx <http://sphinx.pocoo.org>`__,
20 `Python <http://docs.python.org/>`__, `matplotlib
21 <http://matplotlib.sourceforge.net>`__, `NumPy
22 <http://docs.scipy.org/doc/numpy>`__, `Scikit-Learn
23 <http://scikit-learn.org/stable>`__, `Pandas
24 <http://pandas.pydata.org/pandas-docs/stable>`__, `SciPy
25 <http://docs.scipy.org/doc/scipy/reference/>`__. You can add more by
26 extending the ``intersphinx_mapping`` in your Sphinx's ``conf.py``.
27
28Contents
29========
30
31.. toctree::
32 :maxdepth: 2
33
34 License <license>
35 Authors <authors>
36 Changelog <changes>
37 Module Reference <api/modules>
38
39
40Indices and tables
41==================
42
43* :ref:`genindex`
44* :ref:`modindex`
45* :ref:`search`