mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-25 09:19:31 +00:00
Code Issues Releases Wiki Activity

Merge pull request #297 from ThomasWaldmann/help-usage-docs

Browse source 
include the help offered by borg help <topic> in the usage docs, fixes #293
This commit is contained in:
TW 2015-10-18 14:51:12 +02:00
commit 2c4196ed54
2 changed files with 24 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/usage.rst
View file

@ -371,6 +371,12 @@ Examples
command="borg serve --restrict-to-path /mnt/backup" ssh-rsa AAAAB3[...]
Miscellaneous Help
------------------
.. include:: usage/help.rst.inc
Additional Notes
----------------

30
setup.py
View file

@ -150,19 +150,25 @@ def run(self):
if not os.path.exists('docs/usage'):
os.mkdir('docs/usage')
for command, parser in choices.items():
if command is 'help':
continue
print('generating help for %s' % command)
with open('docs/usage/%s.rst.inc' % command, 'w') as doc:
print('generating help for %s' % command)
params = {"command": command,
"underline": '-' * len('borg ' + command)}
doc.write(".. _borg_{command}:\n\n".format(**params))
doc.write("borg {command}\n{underline}\n::\n\n".format(**params))
epilog = parser.epilog
parser.epilog = None
doc.write(re.sub("^", " ", parser.format_help(), flags=re.M))
doc.write("\nDescription\n~~~~~~~~~~~\n")
doc.write(epilog)
if command == 'help':
for topic in Archiver.helptext:
params = {"topic": topic,
"underline": '~' * len('borg help ' + topic)}
doc.write(".. _borg_{topic}:\n\n".format(**params))
doc.write("borg help {topic}\n{underline}\n::\n\n".format(**params))
doc.write(Archiver.helptext[topic])
else:
params = {"command": command,
"underline": '-' * len('borg ' + command)}
doc.write(".. _borg_{command}:\n\n".format(**params))
doc.write("borg {command}\n{underline}\n::\n\n".format(**params))
epilog = parser.epilog
parser.epilog = None
doc.write(re.sub("^", " ", parser.format_help(), flags=re.M))
doc.write("\nDescription\n~~~~~~~~~~~\n")
doc.write(epilog)
# return to regular Cython configuration, if we changed it
if os.environ.get('BORG_CYTHON_DISABLE') == self.__class__.__name__:
del os.environ['BORG_CYTHON_DISABLE']