From 4fecd223c8defc7c2d8b278d0d55a71924357544 Mon Sep 17 00:00:00 2001
From: Thomas Waldmann <tw@waldmann-edv.de>
Date: Sun, 10 Jul 2016 03:05:28 +0200
Subject: [PATCH] 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.
---
 docs/api.rst | 64 +++++++++++++++++++++-------------------------------
 1 file changed, 26 insertions(+), 38 deletions(-)

diff --git a/docs/api.rst b/docs/api.rst
index 718cb58e0..31a22fbb3 100644
--- a/docs/api.rst
+++ b/docs/api.rst
@@ -6,50 +6,18 @@ API Documentation
     :members:
     :undoc-members:
 
-.. automodule:: borg.upgrader
-    :members:
-    :undoc-members:
-
 .. automodule:: borg.archive
     :members:
     :undoc-members:
 
-.. automodule:: borg.fuse
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.platform
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.locking
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.shellpattern
-    :members:
-    :undoc-members:
-
 .. automodule:: borg.repository
     :members:
     :undoc-members:
 
-.. automodule:: borg.lrucache
-    :members:
-    :undoc-members:
-
 .. automodule:: borg.remote
     :members:
     :undoc-members:
 
-.. automodule:: borg.xattr
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.helpers
-    :members:
-    :undoc-members:
-
 .. automodule:: borg.cache
     :members:
     :undoc-members:
@@ -62,7 +30,31 @@ API Documentation
     :members:
     :undoc-members:
 
-.. automodule:: borg.platform_darwin
+.. automodule:: borg.helpers
+    :members:
+    :undoc-members:
+
+.. automodule:: borg.locking
+    :members:
+    :undoc-members:
+
+.. automodule:: borg.shellpattern
+    :members:
+    :undoc-members:
+
+.. automodule:: borg.lrucache
+    :members:
+    :undoc-members:
+
+.. automodule:: borg.fuse
+    :members:
+    :undoc-members:
+
+.. automodule:: borg.xattr
+    :members:
+    :undoc-members:
+
+.. automodule:: borg.platform
     :members:
     :undoc-members:
 
@@ -75,7 +67,7 @@ API Documentation
     :undoc-members:
 
 .. automodule:: borg.compress
-    :members:
+    :members: get_compressor, Compressor, CompressorBase
     :undoc-members:
 
 .. automodule:: borg.chunker
@@ -85,7 +77,3 @@ API Documentation
 .. automodule:: borg.crypto
     :members:
     :undoc-members:
-
-.. automodule:: borg.platform_freebsd
-    :members:
-    :undoc-members: