From b1466f530b99de1b2b8e219495efc832d6a9fe2d Mon Sep 17 00:00:00 2001
From: Marian Beermann <public@enkore.de>
Date: Sat, 25 Mar 2017 15:41:11 +0100
Subject: [PATCH] docs: kill api page

(cherry picked from commit 475d53d9ef8e3dc6c91b3aada499c4196b366f20)
---
 docs/api.rst         | 86 --------------------------------------------
 docs/development.rst | 13 ++++---
 setup.py             | 35 ------------------
 3 files changed, 6 insertions(+), 128 deletions(-)
 delete mode 100644 docs/api.rst

diff --git a/docs/api.rst b/docs/api.rst
deleted file mode 100644
index f05cdbc29..000000000
--- a/docs/api.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-
-.. IMPORTANT: this file is auto-generated by "setup.py build_api", do not edit!
-
-
-API Documentation
-=================
-
-.. automodule:: borg.archive
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.archiver
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.cache
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.chunker
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.compress
-    :members: get_compressor, Compressor, CompressorBase
-    :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_linux
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.remote
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.repository
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.shellpattern
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.xattr
-    :members:
-    :undoc-members:
diff --git a/docs/development.rst b/docs/development.rst
index afc1e21a9..7dc2941ac 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -183,20 +183,19 @@ Important notes:
 Regenerate usage files
 ----------------------
 
-Usage and API documentation is currently committed directly to git,
+Usage documentation is currently committed directly to git,
 although those files are generated automatically from the source
 tree.
 
-When a new module is added, the ``docs/api.rst`` file needs to be
-regenerated::
-
-  ./setup.py build_api
-
 When a command is added, a commandline flag changed, added or removed,
 the usage docs need to be rebuilt as well::
 
   ./setup.py build_usage
 
+However, we prefer to do this as part of our :ref:`releasing`
+preparations, so it is generally not necessary to update these when
+submitting patches that change something about the command line.
+
 Building the docs with Sphinx
 -----------------------------
 
@@ -270,7 +269,7 @@ Checklist:
 - update ``CHANGES.rst``, based on ``git log $PREVIOUS_RELEASE..``
 - check version number of upcoming release in ``CHANGES.rst``
 - verify that ``MANIFEST.in`` and ``setup.py`` are complete
-- ``python setup.py build_api ; python setup.py build_usage`` and commit
+- ``python setup.py build_usage`` and commit
 - tag the release::
 
     git tag -s -m "tagged/signed release X.Y.Z" X.Y.Z
diff --git a/setup.py b/setup.py
index e3b8beb9e..8f65963d5 100644
--- a/setup.py
+++ b/setup.py
@@ -213,43 +213,8 @@ class build_usage(Command):
         return is_subcommand
 
 
-class build_api(Command):
-    description = "generate a basic api.rst file based on the modules available"
-
-    user_options = [
-        ('output=', 'O', 'output directory'),
-    ]
-
-    def initialize_options(self):
-        pass
-
-    def finalize_options(self):
-        pass
-
-    def run(self):
-        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 sorted(glob('borg/*.py') + glob('borg/*.pyx')):
-                print("examining module %s" % mod)
-                mod = mod.replace('.pyx', '').replace('.py', '').replace('/', '.')
-                if "._" not in mod:
-                    doc.write("""
-.. automodule:: %s
-    :members:
-    :undoc-members:
-""" % mod)
-
-
 cmdclass = {
     'build_ext': build_ext,
-    'build_api': build_api,
     'build_usage': build_usage,
     'sdist': Sdist
 }