diff --git a/docs/api.rst b/docs/api.rst index a598457ee..d3e129ad4 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,88 +1,19 @@ +.. IMPORTANT: this file is auto-generated by "setup.py build_api", do not edit! + + API Documentation ================= -.. automodule:: borg.logger - :members: - :undoc-members: - -.. automodule:: borg.upgrader - :members: - :undoc-members: - .. automodule:: borg.archive :members: :undoc-members: -.. automodule:: borg.cache - :members: - :undoc-members: - -.. automodule:: borg.key - :members: - :undoc-members: - -.. automodule:: borg.lrucache - :members: - :undoc-members: - .. automodule:: borg.archiver :members: :undoc-members: -.. automodule:: borg.xattr - :members: - :undoc-members: - -.. automodule:: borg.fuse - :members: - :undoc-members: - -.. automodule:: borg.keymanager - :members: - :undoc-members: - -.. automodule:: borg.shellpattern - :members: - :undoc-members: - -.. automodule:: borg.remote - :members: - :undoc-members: - -.. automodule:: borg.helpers - :members: - :undoc-members: - -.. automodule:: borg.locking - :members: - :undoc-members: - -.. automodule:: borg.platform - :members: - :undoc-members: - -.. automodule:: borg.repository - :members: - :undoc-members: - -.. automodule:: borg.hashindex - :members: - :undoc-members: - -.. automodule:: borg.platform_darwin - :members: - :undoc-members: - -.. automodule:: borg.crypto - :members: - :undoc-members: - -.. automodule:: borg.platform_linux - :members: - :undoc-members: - -.. automodule:: borg.platform_freebsd +.. automodule:: borg.cache :members: :undoc-members: @@ -93,3 +24,75 @@ API Documentation .. automodule:: borg.compress :members: :undoc-members: + +.. automodule:: borg.crypto + :members: + :undoc-members: + +.. automodule:: borg.fuse + :members: + :undoc-members: + +.. automodule:: borg.hashindex + :members: + :undoc-members: + +.. automodule:: borg.helpers + :members: + :undoc-members: + +.. automodule:: borg.key + :members: + :undoc-members: + +.. automodule:: borg.keymanager + :members: + :undoc-members: + +.. automodule:: borg.locking + :members: + :undoc-members: + +.. automodule:: borg.logger + :members: + :undoc-members: + +.. automodule:: borg.lrucache + :members: + :undoc-members: + +.. automodule:: borg.platform + :members: + :undoc-members: + +.. automodule:: borg.platform_darwin + :members: + :undoc-members: + +.. automodule:: borg.platform_freebsd + :members: + :undoc-members: + +.. automodule:: borg.platform_linux + :members: + :undoc-members: + +.. automodule:: borg.remote + :members: + :undoc-members: + +.. automodule:: borg.repository + :members: + :undoc-members: + +.. automodule:: borg.shellpattern + :members: + :undoc-members: + +.. automodule:: borg.upgrader + :members: + :undoc-members: + +.. automodule:: borg.xattr + :members: + :undoc-members: diff --git a/docs/changes.rst b/docs/changes.rst index 911665167..5a6f31e78 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -155,6 +155,7 @@ Other changes: - language clarification - "borg create --one-file-system" option does not respect mount points, but considers different file systems instead, #2141 +- setup.py: build_api: sort file list for determinism Version 1.0.10rc1 (2017-01-29) ------------------------------ diff --git a/setup.py b/setup.py index 4e816907e..e3b8beb9e 100644 --- a/setup.py +++ b/setup.py @@ -230,10 +230,13 @@ class build_api(Command): print("auto-generating API documentation") with open("docs/api.rst", "w") as doc: doc.write(""" +.. IMPORTANT: this file is auto-generated by "setup.py build_api", do not edit! + + API Documentation ================= """) - for mod in glob('borg/*.py') + glob('borg/*.pyx'): + for mod in sorted(glob('borg/*.py') + glob('borg/*.pyx')): print("examining module %s" % mod) mod = mod.replace('.pyx', '').replace('.py', '').replace('/', '.') if "._" not in mod: