mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-26 09:47:58 +00:00
Code Issues Releases Wiki Activity
borg/docs/api.rst

85 lines
1.4 KiB
ReStructuredText
Raw Normal View History

docs: fix the highlighting default is "python", that's why some help fragments and bash scripts looked strange.
2016-07-11 21:16:53 +00:00
.. highlight:: python
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
API Documentation
=================
ran build_api + build_usage
2016-05-20 12:34:48 +00:00
.. automodule:: borg.archiver
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api + build_usage
2016-05-20 12:34:48 +00:00
.. automodule:: borg.archive
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.repository
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.remote
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.cache
ran setup.py build_api
2016-01-23 19:52:04 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.key
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
update api.rst
2016-10-17 01:36:49 +00:00
.. automodule:: borg.keymanager
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.logger
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.helpers
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.locking
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.shellpattern
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.lrucache
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.fuse
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.xattr
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
.. automodule:: borg.platform
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api + build_usage
2016-05-20 12:34:48 +00:00
.. automodule:: borg.platform_linux
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api + build_usage
2016-05-20 12:34:48 +00:00
.. automodule:: borg.hashindex
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api + build_usage
2016-05-20 12:34:48 +00:00
.. automodule:: borg.compress
api.rst: remove problematic stuff, fixes #881 some cython stuff can't be processed by sphinx. some platform-dependant modules can't get imported. also: reordered modules in api.rst so order makes some sense.
2016-07-10 01:05:28 +00:00
:members: get_compressor, Compressor, CompressorBase
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:undoc-members:
ran build_api and build_usage
2015-12-13 14:47:03 +00:00
.. automodule:: borg.chunker
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
ran build_api + build_usage
2016-05-20 12:34:48 +00:00
.. automodule:: borg.crypto
commit usage files directly into git the generation of those files was causing us way too much pain to justify automatically generating them all the time. those will have to be re-generated with `build_api` or `build_usage` as appropriate, for example when function signatures or commandline flags change. see #384
2015-11-13 15:42:16 +00:00
:members:
:undoc-members:
Reference in a new issue Copy permalink