about summary refs log tree commit diff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorJaime Marquínez Ferrándiz <jaime.marquinez.ferrandiz@gmail.com>2014-03-15 19:08:09 +0100
committerJaime Marquínez Ferrándiz <jaime.marquinez.ferrandiz@gmail.com>2014-03-15 19:08:09 +0100
commit685052fc7b8e7c70fc524098e45f0c1052c5eaec (patch)
treec531a6a5ded1da0eb8f75bea48573eef01c23e40 /docs/index.rst
parentf1cef7a9ffcf92781e8ee81934a1bf985aefdbca (diff)
downloadyoutube-dl-685052fc7b8e7c70fc524098e45f0c1052c5eaec.tar.gz
youtube-dl-685052fc7b8e7c70fc524098e45f0c1052c5eaec.tar.xz
youtube-dl-685052fc7b8e7c70fc524098e45f0c1052c5eaec.zip
Add initial sphinx docs
With an initial guide for using youtube_dl from python programs.
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst23
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 000000000..b746ff95b
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,23 @@
+Welcome to youtube-dl's documentation!
+======================================
+
+*youtube-dl* is a command-line program to download videos from YouTube.com and more sites.
+It can also be used in Python code.
+
+Developer guide
+---------------
+
+This section contains information for using *youtube-dl* from Python programs.
+
+.. toctree::
+    :maxdepth: 2
+
+    module_guide
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+