浏览代码

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.
Thomas Waldmann 9 年之前
父节点
当前提交
4fecd223c8
共有 1 个文件被更改,包括 13 次插入25 次删除
  1. 13 25
      docs/api.rst

+ 13 - 25
docs/api.rst

@@ -6,63 +6,55 @@ API Documentation
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.upgrader
-    :members:
-    :undoc-members:
-
 .. automodule:: borg.archive
 .. automodule:: borg.archive
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.fuse
-    :members:
-    :undoc-members:
-
-.. automodule:: borg.platform
+.. automodule:: borg.repository
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.locking
+.. automodule:: borg.remote
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.shellpattern
+.. automodule:: borg.cache
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.repository
+.. automodule:: borg.key
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.lrucache
+.. automodule:: borg.logger
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.remote
+.. automodule:: borg.helpers
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.xattr
+.. automodule:: borg.locking
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.helpers
+.. automodule:: borg.shellpattern
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.cache
+.. automodule:: borg.lrucache
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.key
+.. automodule:: borg.fuse
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.logger
+.. automodule:: borg.xattr
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
-.. automodule:: borg.platform_darwin
+.. automodule:: borg.platform
     :members:
     :members:
     :undoc-members:
     :undoc-members:
 
 
@@ -75,7 +67,7 @@ API Documentation
     :undoc-members:
     :undoc-members:
 
 
 .. automodule:: borg.compress
 .. automodule:: borg.compress
-    :members:
+    :members: get_compressor, Compressor, CompressorBase
     :undoc-members:
     :undoc-members:
 
 
 .. automodule:: borg.chunker
 .. automodule:: borg.chunker
@@ -85,7 +77,3 @@ API Documentation
 .. automodule:: borg.crypto
 .. automodule:: borg.crypto
     :members:
     :members:
     :undoc-members:
     :undoc-members:
-
-.. automodule:: borg.platform_freebsd
-    :members:
-    :undoc-members: