about summary refs log tree commit diff
path: root/devscripts
diff options
context:
space:
mode:
authorYen Chi Hsuan <yan12125@gmail.com>2015-09-13 20:10:23 +0800
committerJaime Marquínez Ferrándiz <jaime.marquinez.ferrandiz@gmail.com>2015-10-03 00:01:10 +0200
commitbad84757eb135b85d5a1b29524a064d23ab4e1e9 (patch)
treef9118323facb9eef6371696294a8e374720c93d7 /devscripts
parent13118a50b88c26fe5d932eccf77e297249a78634 (diff)
downloadyoutube-dl-bad84757eb135b85d5a1b29524a064d23ab4e1e9.tar.gz
youtube-dl-bad84757eb135b85d5a1b29524a064d23ab4e1e9.tar.xz
youtube-dl-bad84757eb135b85d5a1b29524a064d23ab4e1e9.zip
[doc] Better formatting of youtube-dl.1 (closes #6510)
Diffstat (limited to 'devscripts')
-rw-r--r--devscripts/prepare_manpage.py31
1 files changed, 31 insertions, 0 deletions
diff --git a/devscripts/prepare_manpage.py b/devscripts/prepare_manpage.py
index 7ece37754..776e6556e 100644
--- a/devscripts/prepare_manpage.py
+++ b/devscripts/prepare_manpage.py
@@ -8,6 +8,35 @@ import re
 ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 README_FILE = os.path.join(ROOT_DIR, 'README.md')
 
+
+def filter_options(readme):
+    ret = ''
+    in_options = False
+    for line in readme.split('\n'):
+        if line.startswith('# '):
+            if line[2:].startswith('OPTIONS'):
+                in_options = True
+            else:
+                in_options = False
+
+        if in_options:
+            if line.lstrip().startswith('-'):
+                option, description = re.split(r'\s{2,}', line.lstrip())
+                split_option = option.split(' ')
+
+                if not split_option[-1].startswith('-'):  # metavar
+                    option = ' '.join(split_option[:-1] + ['*%s*' % split_option[-1]])
+
+                # Pandoc's definition_lists. See http://pandoc.org/README.html
+                # for more information.
+                ret += '\n%s\n:   %s\n' % (option, description)
+            else:
+                ret += line.lstrip() + '\n'
+        else:
+            ret += line + '\n'
+
+    return ret
+
 with io.open(README_FILE, encoding='utf-8') as f:
     readme = f.read()
 
@@ -26,6 +55,8 @@ readme = re.sub(r'(?s)^.*?(?=# DESCRIPTION)', '', readme)
 readme = re.sub(r'\s+youtube-dl \[OPTIONS\] URL \[URL\.\.\.\]', '', readme)
 readme = PREFIX + readme
 
+readme = filter_options(readme)
+
 if sys.version_info < (3, 0):
     print(readme.encode('utf-8'))
 else: