diff options
27 files changed, 4 insertions, 161 deletions
diff --git a/docs/borg_domain.py b/docs/borg_domain.py deleted file mode 100644 index 625e8140b..000000000 --- a/docs/borg_domain.py +++ /dev/null @@ -1,102 +0,0 @@ -from sphinx import addnodes -from sphinx.domains import Domain, ObjType -from sphinx.locale import l_, _ -from sphinx.directives import ObjectDescription -from sphinx.domains.std import ws_re - - -class BorgObject(ObjectDescription): - indextemplate = l_('%s') - parse_node = None # type: Callable[[GenericObject, BuildEnvironment, unicode, addnodes.desc_signature], unicode] # NOQA - - def handle_signature(self, sig, signode): - # type: (unicode, addnodes.desc_signature) -> unicode - pass - - def add_target_and_index(self, name, sig, signode): - # type: (str, str, addnodes.desc_signature) -> None - # ^ ignore this one, don't insert any markup. - # v- the human text v- the target name - # "borg key change-passphrase" -> "borg-key-change-passphrase" - del name # ignored - targetname = sig.replace(' ', '-') - if self.indextemplate: - colon = self.indextemplate.find(':') - if colon != -1: - indextype = self.indextemplate[:colon].strip() - indexentry = self.indextemplate[colon + 1:].strip() % (sig,) - else: - indextype = 'single' - indexentry = self.indextemplate % (sig,) - self.indexnode['entries'].append((indextype, indexentry, targetname, '', None)) - self.env.domaindata['borg']['objects'][targetname] = self.env.docname, self.objtype, sig - - def run(self): - super().run() - return [self.indexnode] - - -class BorgCommand(BorgObject): - """ - Inserts an index entry and an anchor for a borg command. - - For example, the following snippet creates an index entry about the "borg foo-and-bar" - command as well as a "borg-foo-and-bar" anchor (id). - - .. borg:command:: borg foo-and-bar - """ - - indextemplate = l_('%s (command)') - - -class BorgEnvVar(BorgObject): - """ - Inserts an index entry and an anchor for an environment variable. - (Currently not used) - """ - - indextemplate = l_('%s (environment variable)') - - -class BorgDomain(Domain): - """Land of the Borg.""" - name = 'borg' - label = 'Borg' - object_types = { - 'command': ObjType(l_('command')), - 'env_var': ObjType(l_('env_var')), - } - directives = { - 'command': BorgCommand, - 'env_var': BorgEnvVar, - } - roles = {} - initial_data = { - 'objects': {}, # fullname -> docname, objtype - } - - def clear_doc(self, docname): - # required for incremental builds - try: - del self.data['objects'][docname] - except KeyError: - pass - - def merge_domaindata(self, docnames, otherdata): - # needed due to parallel_read_safe - for fullname, (docname, objtype, sig) in otherdata['objects'].items(): - if docname in docnames: - self.data['objects'][fullname] = (docname, objtype, sig) - - def get_objects(self): - for refname, (docname, objtype, sig) in list(self.data['objects'].items()): - yield sig, sig, objtype, docname, refname, 1 - - -def setup(app): - app.add_domain(BorgDomain) - return { - 'version': 1, - 'parallel_read_safe': True, - 'parallel_write_safe': True, - } diff --git a/docs/conf.py b/docs/conf.py index 9a541ac15..dc40f2a0c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -16,7 +16,6 @@ # documentation root, use os.path.abspath to make it absolute, like shown here. import sys, os sys.path.insert(0, os.path.abspath('../src')) -sys.path.insert(0, os.path.abspath('.')) from borg import __version__ as sw_version @@ -27,7 +26,9 @@ on_rtd = os.environ.get('READTHEDOCS', None) == 'True' # If your documentation needs a minimal Sphinx version, state it here. #needs_sphinx = '1.0' -# Extensions are defined at the end of this file. +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = [] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -240,14 +241,7 @@ man_pages = [ 1), ] -extensions = [ - 'sphinx.ext.extlinks', - 'sphinx.ext.autodoc', - 'sphinx.ext.todo', - 'sphinx.ext.coverage', - 'sphinx.ext.viewcode', - 'borg_domain', -] +extensions = ['sphinx.ext.extlinks', 'sphinx.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] extlinks = { 'issue': ('https://github.com/borgbackup/borg/issues/%s', '#'), diff --git a/docs/usage/benchmark_crud.rst.inc b/docs/usage/benchmark_crud.rst.inc index 604c8795b..d47e8d62b 100644 --- a/docs/usage/benchmark_crud.rst.inc +++ b/docs/usage/benchmark_crud.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg benchmark crud - .. _borg_benchmark_crud: borg benchmark crud diff --git a/docs/usage/break-lock.rst.inc b/docs/usage/break-lock.rst.inc index 24a973039..1b8e5915a 100644 --- a/docs/usage/break-lock.rst.inc +++ b/docs/usage/break-lock.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg break-lock - .. _borg_break-lock: borg break-lock diff --git a/docs/usage/change-passphrase.rst.inc b/docs/usage/change-passphrase.rst.inc index 7763745cd..b0a6c2bbb 100644 --- a/docs/usage/change-passphrase.rst.inc +++ b/docs/usage/change-passphrase.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg change-passphrase - .. _borg_change-passphrase: borg change-passphrase diff --git a/docs/usage/check.rst.inc b/docs/usage/check.rst.inc index 73b3ab8e0..56bc42c8c 100644 --- a/docs/usage/check.rst.inc +++ b/docs/usage/check.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg check - .. _borg_check: borg check diff --git a/docs/usage/create.rst.inc b/docs/usage/create.rst.inc index d02072f96..6b7006cb3 100644 --- a/docs/usage/create.rst.inc +++ b/docs/usage/create.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg create - .. _borg_create: borg create diff --git a/docs/usage/delete.rst.inc b/docs/usage/delete.rst.inc index fe750682f..0977f0221 100644 --- a/docs/usage/delete.rst.inc +++ b/docs/usage/delete.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg delete - .. _borg_delete: borg delete diff --git a/docs/usage/diff.rst.inc b/docs/usage/diff.rst.inc index 12f6e9e37..0163c5dc1 100644 --- a/docs/usage/diff.rst.inc +++ b/docs/usage/diff.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg diff - .. _borg_diff: borg diff diff --git a/docs/usage/export-tar.rst.inc b/docs/usage/export-tar.rst.inc index 4b8015708..f2c4e03a0 100644 --- a/docs/usage/export-tar.rst.inc +++ b/docs/usage/export-tar.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg export-tar - .. _borg_export-tar: borg export-tar diff --git a/docs/usage/extract.rst.inc b/docs/usage/extract.rst.inc index 95b7f3bb4..f5b2d4947 100644 --- a/docs/usage/extract.rst.inc +++ b/docs/usage/extract.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg extract - .. _borg_extract: borg extract diff --git a/docs/usage/info.rst.inc b/docs/usage/info.rst.inc index d6de93499..0376329ab 100644 --- a/docs/usage/info.rst.inc +++ b/docs/usage/info.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg info - .. _borg_info: borg info diff --git a/docs/usage/init.rst.inc b/docs/usage/init.rst.inc index e23e9cb95..a5a6dbfd8 100644 --- a/docs/usage/init.rst.inc +++ b/docs/usage/init.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg init - .. _borg_init: borg init diff --git a/docs/usage/key_change-passphrase.rst.inc b/docs/usage/key_change-passphrase.rst.inc index ffc022097..7666afc2f 100644 --- a/docs/usage/key_change-passphrase.rst.inc +++ b/docs/usage/key_change-passphrase.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg key change-passphrase - .. _borg_key_change-passphrase: borg key change-passphrase diff --git a/docs/usage/key_export.rst.inc b/docs/usage/key_export.rst.inc index 6f27448c7..e976ae2dc 100644 --- a/docs/usage/key_export.rst.inc +++ b/docs/usage/key_export.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg key export - .. _borg_key_export: borg key export diff --git a/docs/usage/key_import.rst.inc b/docs/usage/key_import.rst.inc index 92c686718..ceb89e3f7 100644 --- a/docs/usage/key_import.rst.inc +++ b/docs/usage/key_import.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg key import - .. _borg_key_import: borg key import diff --git a/docs/usage/key_migrate-to-repokey.rst.inc b/docs/usage/key_migrate-to-repokey.rst.inc index 5faabf317..df242566f 100644 --- a/docs/usage/key_migrate-to-repokey.rst.inc +++ b/docs/usage/key_migrate-to-repokey.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg key migrate-to-repokey - .. _borg_key_migrate-to-repokey: borg key migrate-to-repokey diff --git a/docs/usage/list.rst.inc b/docs/usage/list.rst.inc index 147de2efe..cd8db74c9 100644 --- a/docs/usage/list.rst.inc +++ b/docs/usage/list.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg list - .. _borg_list: borg list diff --git a/docs/usage/mount.rst.inc b/docs/usage/mount.rst.inc index d17f19217..026cc680f 100644 --- a/docs/usage/mount.rst.inc +++ b/docs/usage/mount.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg mount - .. _borg_mount: borg mount diff --git a/docs/usage/prune.rst.inc b/docs/usage/prune.rst.inc index ff288feb5..40e0c26cc 100644 --- a/docs/usage/prune.rst.inc +++ b/docs/usage/prune.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg prune - .. _borg_prune: borg prune diff --git a/docs/usage/recreate.rst.inc b/docs/usage/recreate.rst.inc index 3b6fc04ca..fd3ef446d 100644 --- a/docs/usage/recreate.rst.inc +++ b/docs/usage/recreate.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg recreate - .. _borg_recreate: borg recreate diff --git a/docs/usage/rename.rst.inc b/docs/usage/rename.rst.inc index c5e98f318..13baa7e45 100644 --- a/docs/usage/rename.rst.inc +++ b/docs/usage/rename.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg rename - .. _borg_rename: borg rename diff --git a/docs/usage/serve.rst.inc b/docs/usage/serve.rst.inc index 945ff1749..f3f1aa659 100644 --- a/docs/usage/serve.rst.inc +++ b/docs/usage/serve.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg serve - .. _borg_serve: borg serve diff --git a/docs/usage/umount.rst.inc b/docs/usage/umount.rst.inc index 8be61e6b5..ab02038b8 100644 --- a/docs/usage/umount.rst.inc +++ b/docs/usage/umount.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg umount - .. _borg_umount: borg umount diff --git a/docs/usage/upgrade.rst.inc b/docs/usage/upgrade.rst.inc index 13fd247ec..bdf76ccd3 100644 --- a/docs/usage/upgrade.rst.inc +++ b/docs/usage/upgrade.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg upgrade - .. _borg_upgrade: borg upgrade diff --git a/docs/usage/with-lock.rst.inc b/docs/usage/with-lock.rst.inc index 34a2b69d2..47b5abcc3 100644 --- a/docs/usage/with-lock.rst.inc +++ b/docs/usage/with-lock.rst.inc @@ -1,7 +1,5 @@ .. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit! -.. borg:command:: borg with-lock - .. _borg_with-lock: borg with-lock @@ -258,7 +258,6 @@ class build_usage(Command): params = {"command": command, "command_": command.replace(' ', '_'), "underline": '-' * len('borg ' + command)} - doc.write(".. borg:command:: borg {command}\n\n".format(**params)) doc.write(".. _borg_{command_}:\n\n".format(**params)) doc.write("borg {command}\n{underline}\n::\n\n borg [common options] {command}".format(**params)) self.write_usage(parser, doc) |