mirror of
https://github.com/yt-dlp/yt-dlp.git
synced 2024-09-11 17:06:35 +02:00
[doc] Better formatting of youtube-dl.1 (closes #6510)
This commit is contained in:
parent
13118a50b8
commit
bad84757eb
@ -8,6 +8,35 @@
|
|||||||
ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
|
||||||
README_FILE = os.path.join(ROOT_DIR, 'README.md')
|
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:
|
with io.open(README_FILE, encoding='utf-8') as f:
|
||||||
readme = f.read()
|
readme = f.read()
|
||||||
|
|
||||||
@ -26,6 +55,8 @@
|
|||||||
readme = re.sub(r'\s+youtube-dl \[OPTIONS\] URL \[URL\.\.\.\]', '', readme)
|
readme = re.sub(r'\s+youtube-dl \[OPTIONS\] URL \[URL\.\.\.\]', '', readme)
|
||||||
readme = PREFIX + readme
|
readme = PREFIX + readme
|
||||||
|
|
||||||
|
readme = filter_options(readme)
|
||||||
|
|
||||||
if sys.version_info < (3, 0):
|
if sys.version_info < (3, 0):
|
||||||
print(readme.encode('utf-8'))
|
print(readme.encode('utf-8'))
|
||||||
else:
|
else:
|
||||||
|
Loading…
Reference in New Issue
Block a user