From f1ddf104809017784aa136ebb8ff7e2cfb96d5f4 Mon Sep 17 00:00:00 2001 From: Tom van der Lee Date: Sun, 11 Oct 2015 00:15:23 +0200 Subject: Changed directory structure to use pyscaffold --- docs/index.rst | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/index.rst (limited to 'docs/index.rst') 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 @@ +================= +youtube-podcaster +================= + +This is the documentation of **youtube-podcaster**. + +.. note:: + + This is the main page of your project's `Sphinx `_ + documentation. It is formatted in `reStructuredText + `__. Add additional pages by creating + rst-files in ``docs`` and adding them to the `toctree + `_ below. Use then + `references `__ in order to link + them from this page, e.g. :ref:`authors ` and :ref:`changes`. + It is also possible to refer to the documentation of other Python packages + with the `Python domain syntax + `__. By default you + can reference the documentation of `Sphinx `__, + `Python `__, `matplotlib + `__, `NumPy + `__, `Scikit-Learn + `__, `Pandas + `__, `SciPy + `__. You can add more by + extending the ``intersphinx_mapping`` in your Sphinx's ``conf.py``. + +Contents +======== + +.. toctree:: + :maxdepth: 2 + + License + Authors + Changelog + Module Reference + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` -- cgit v1.2.3