From 904954f1a092dda7d435a3a0ccfade40e158a297 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jaime=20Marqui=CC=81nez=20Ferra=CC=81ndiz?= Date: Mon, 24 Mar 2014 19:52:53 +0100 Subject: [PATCH] docs: Add a manpage --- MANIFEST.in | 2 +- docs/conf.py | 4 ++++ docs/youtube-dl.1.rst | 22 ++++++++++++++++++++++ 3 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 docs/youtube-dl.1.rst diff --git a/MANIFEST.in b/MANIFEST.in index d43cc1f3b..1943a75b5 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -3,4 +3,4 @@ include test/*.py include test/*.json include youtube-dl.bash-completion include youtube-dl.1 -recursive-include docs Makefile conf.py *.rst +recursive-include docs Makefile conf.py *.rst *.rst.inc diff --git a/docs/conf.py b/docs/conf.py index 4a04ad779..678e513d9 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -69,3 +69,7 @@ html_static_path = ['_static'] # Output file base name for HTML help builder. htmlhelp_basename = 'youtube-dldoc' + + +# -- Options for the man page --------------------------------------------- +man_pages = [('youtube-dl.1', 'youtube-dl', 'download videos from youtube.com or other video platforms', 'Ricardo Garcia Gonzalez', 1)] diff --git a/docs/youtube-dl.1.rst b/docs/youtube-dl.1.rst new file mode 100644 index 000000000..d3308118e --- /dev/null +++ b/docs/youtube-dl.1.rst @@ -0,0 +1,22 @@ +:orphan: + +YOUTUBE-DL(1) +************* + +SYNOPSIS +======== + +**youtube-dl** [OPTIONS] URL [URL...] + +DESCRIPTION +=========== + +**youtube-dl** is a small command-line program to download videos from +YouTube.com and a few more sites. It requires the Python interpreter, version +2.6, 2.7, or 3.3+, and it is not platform specific. It should work on +your Unix box, on Windows or on Mac OS X. It is released to the public domain, +which means you can modify it, redistribute it or use it however you like. + +OPTIONS +======= +.. include:: options.rst.inc