aboutsummaryrefslogtreecommitdiffstats
path: root/devscripts/make_readme.py
diff options
context:
space:
mode:
Diffstat (limited to 'devscripts/make_readme.py')
-rwxr-xr-xdevscripts/make_readme.py25
1 files changed, 14 insertions, 11 deletions
diff --git a/devscripts/make_readme.py b/devscripts/make_readme.py
index 1719ac8e4..1401c2e5a 100755
--- a/devscripts/make_readme.py
+++ b/devscripts/make_readme.py
@@ -6,22 +6,25 @@ import re
import sys
README_FILE = 'README.md'
-helptext = sys.stdin.read()
+OPTIONS_START = 'General Options:'
+OPTIONS_END = 'CONFIGURATION'
+EPILOG_START = 'See full documentation'
+
+
+helptext = sys.stdin.read()
if isinstance(helptext, bytes):
helptext = helptext.decode('utf-8')
-with open(README_FILE, encoding='utf-8') as f:
- oldreadme = f.read()
+start, end = helptext.index(f'\n {OPTIONS_START}'), helptext.index(f'\n{EPILOG_START}')
+options = re.sub(r'(?m)^ (\w.+)$', r'## \1', helptext[start + 1: end + 1])
-header = oldreadme[:oldreadme.index('## General Options:')]
-footer = oldreadme[oldreadme.index('# CONFIGURATION'):]
+with open(README_FILE, encoding='utf-8') as f:
+ readme = f.read()
-options = helptext[helptext.index(' General Options:'):]
-options = re.sub(r'(?m)^ (\w.+)$', r'## \1', options)
-options = options + '\n'
+header = readme[:readme.index(f'## {OPTIONS_START}')]
+footer = readme[readme.index(f'# {OPTIONS_END}'):]
with open(README_FILE, 'w', encoding='utf-8') as f:
- f.write(header)
- f.write(options)
- f.write(footer)
+ for part in (header, options, footer):
+ f.write(part)