Let autodoc only document classes and methods relevent for the user

- see #186

Author: mrbean-bremen

Diff for: docs/conf.py

@@ -107,6 +107,10 @@
 #
 # show_authors = False
 
+autoclass_content = 'both'
+
+autodoc_member_order = 'bysource'
+
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 

Diff for: docs/modules.rst

@@ -1,34 +1,43 @@
-Modules
-=======
+Public Classes
+==============
 
-pyfakefs.fake_filesystem module
--------------------------------
+Fake filesystem classes
+-----------------------
 
-.. automodule:: pyfakefs.fake_filesystem
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. autoclass:: pyfakefs.fake_filesystem.FakeFilesystem
+    :members: AddMountPoint,
+        GetDiskUsage, SetDiskUsage, ChangeDiskUsage,
+        add_real_directory, add_real_file, add_real_paths,
+        CreateDirectory, CreateFile
 
-pyfakefs.fake_filesystem_shutil module
---------------------------------------
+.. autoclass:: pyfakefs.fake_filesystem.FakeFile
+    :members: byte_contents, contents, GetPath, GetSize,
+        IsLargeFile, SetContents, SetSize
 
-.. automodule:: pyfakefs.fake_filesystem_shutil
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. autoclass:: pyfakefs.fake_filesystem.FakeDirectory
+    :members: contents, GetEntry, GetSize, RemoveEntry
 
-pyfakefs.fake_pathlib module
-----------------------------
+Unittest module classes
+-----------------------
 
-.. automodule:: pyfakefs.fake_pathlib
-    :members:
-    :undoc-members:
-    :show-inheritance:
+.. autoclass:: pyfakefs.fake_filesystem_unittest.TestCase
+    :members: fs, patches, setUpPyfakefs
 
-pyfakefs.fake_filesystem_unittest module
-----------------------------------------
+.. autoclass:: pyfakefs.fake_filesystem_unittest.Patcher
+    :members: setUp, tearDown
+
+Faked module classes
+--------------------
+
+.. autoclass:: pyfakefs.fake_filesystem.FakeOsModule
+
+.. autoclass:: pyfakefs.fake_filesystem.FakePathModule
+
+.. autoclass:: pyfakefs.fake_filesystem.FakeFileOpen
+
+.. autoclass:: pyfakefs.fake_filesystem.FakeIoModule
+
+.. autoclass:: pyfakefs.fake_filesystem_shutil.FakeShutilModule
+
+.. autoclass:: pyfakefs.fake_pathlib.FakePathlibModule
 
-.. automodule:: pyfakefs.fake_filesystem_unittest
-    :members:
-    :undoc-members:
-    :show-inheritance:

Diff for: pyfakefs/fake_filesystem_unittest.py

@@ -119,7 +119,8 @@ def __init__(self, methodName='runTest', additional_skip_names=None,
             patch_path: if False, modules named 'path' will not be patched with the
                 fake 'os.path' module. Set this to False when you need to import
                 some other module named 'path', for example::
-                        from my_module import path
+                    from my_module import path
+
                 Irrespective of patch_path, module 'os.path' is still correctly faked
                 if imported the usual way using `import os` or `import os.path`.
             special_names: A dictionary with module names as key and a dictionary as
@@ -130,7 +131,7 @@ def __init__(self, methodName='runTest', additional_skip_names=None,
             modules_to_reload (experimental): A list of modules that need to be reloaded
                 to be patched dynamically; may be needed if the module
                 imports file system modules under an alias
-                Note: this is done independently of `use_dynamic_patch'
+                Note: this is done independently of `use_dynamic_patch`
                 Caution: this may not work with some Python versions
                 or have unwanted side effects.
             use_dynamic_patch (experimental): If `True`, dynamic patching