]> jfr.im git - yt-dlp.git/blobdiff - devscripts/make_readme.py
[docs] Improve manpage format (#2003)
[yt-dlp.git] / devscripts / make_readme.py
index 7f2ea319cca5c7c3433665c534758e93fedf8f89..3f56af74470b5dbb3396a5fc52c29cac77f40e57 100755 (executable)
@@ -1,20 +1,31 @@
+#!/usr/bin/env python3
+
+# yt-dlp --help | make_readme.py
+# This must be run in a console of correct width
+
+from __future__ import unicode_literals
+
+import io
 import sys
 import re
 
 README_FILE = 'README.md'
 helptext = sys.stdin.read()
 
-with open(README_FILE) as f:
+if isinstance(helptext, bytes):
+    helptext = helptext.decode('utf-8')
+
+with io.open(README_FILE, encoding='utf-8') as f:
     oldreadme = f.read()
 
-header = oldreadme[:oldreadme.index('# OPTIONS')]
+header = oldreadme[:oldreadme.index('## General Options:')]
 footer = oldreadme[oldreadme.index('# CONFIGURATION'):]
 
-options = helptext[helptext.index('  General Options:')+19:]
-options = re.sub(r'^  (\w.+)$', r'## \1', options, flags=re.M)
-options = '# OPTIONS\n' + options + '\n'
+options = helptext[helptext.index('  General Options:'):]
+options = re.sub(r'(?m)^  (\w.+)$', r'## \1', options)
+options = options + '\n'
 
-with open(README_FILE, 'w') as f:
+with io.open(README_FILE, 'w', encoding='utf-8') as f:
     f.write(header)
     f.write(options)
     f.write(footer)