Remove undoc-members and add documentation for __init__

The public API should all be documented. Anything that isn't documented with a
docstring or starts with a _ isn't part of the public API. Given that, we
shouldn't be autodoc'ing undocumented members.

We do want to document __init__ since that's how the classes get built. So
we explicitly add that to autodoc.

I think this is a good base to build on. If it isn't, we can adjust things
and maybe explicitly specify what should and shouldn't be documented.

Author: willkg

doc/html5lib.filters.rst

@@ -6,54 +6,53 @@ filters Package
 
 .. automodule:: html5lib.filters.base
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`alphabeticalattributes` Module
 ------------------------------------
 
 .. automodule:: html5lib.filters.alphabeticalattributes
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`inject_meta_charset` Module
 ---------------------------------
 
 .. automodule:: html5lib.filters.inject_meta_charset
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`lint` Module
 ------------------
 
 .. automodule:: html5lib.filters.lint
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`optionaltags` Module
 --------------------------
 
 .. automodule:: html5lib.filters.optionaltags
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`sanitizer` Module
 -----------------------
 
 .. automodule:: html5lib.filters.sanitizer
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`whitespace` Module
 ------------------------
 
 .. automodule:: html5lib.filters.whitespace
     :members:
-    :undoc-members:
     :show-inheritance:
-
+    :special-members: __init__

doc/html5lib.rst

@@ -9,24 +9,23 @@ html5lib Package
 
 .. automodule:: html5lib.constants
     :members:
-    :undoc-members:
     :show-inheritance:
 
 :mod:`html5parser` Module
 -------------------------
 
 .. automodule:: html5lib.html5parser
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`serializer` Module
 ------------------------
 
 .. automodule:: html5lib.serializer
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 Subpackages
 -----------
@@ -37,4 +36,3 @@ Subpackages
     html5lib.treebuilders
     html5lib.treewalkers
     html5lib.treeadapters
-

doc/html5lib.treeadapters.rst

@@ -1,20 +1,20 @@
-treebuilders Package
+treeadapters Package
 ====================
 
 :mod:`~html5lib.treeadapters` Package
 -------------------------------------
 
 .. automodule:: html5lib.treeadapters
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 .. automodule:: html5lib.treeadapters.genshi
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 .. automodule:: html5lib.treeadapters.sax
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__

doc/html5lib.treebuilders.rst

@@ -6,38 +6,37 @@ treebuilders Package
 
 .. automodule:: html5lib.treebuilders
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`base` Module
 -------------------
 
 .. automodule:: html5lib.treebuilders.base
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`dom` Module
 -----------------
 
 .. automodule:: html5lib.treebuilders.dom
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`etree` Module
 -------------------
 
 .. automodule:: html5lib.treebuilders.etree
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`etree_lxml` Module
 ------------------------
 
 .. automodule:: html5lib.treebuilders.etree_lxml
     :members:
-    :undoc-members:
     :show-inheritance:
-
+    :special-members: __init__

doc/html5lib.treewalkers.rst

@@ -6,46 +6,45 @@ treewalkers Package
 
 .. automodule:: html5lib.treewalkers
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`base` Module
 ------------------
 
 .. automodule:: html5lib.treewalkers.base
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`dom` Module
 -----------------
 
 .. automodule:: html5lib.treewalkers.dom
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`etree` Module
 -------------------
 
 .. automodule:: html5lib.treewalkers.etree
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__
 
 :mod:`etree_lxml` Module
 ------------------------
 
 .. automodule:: html5lib.treewalkers.etree_lxml
     :members:
-    :undoc-members:
     :show-inheritance:
-
+    :special-members: __init__
 
 :mod:`genshi` Module
 --------------------
 
 .. automodule:: html5lib.treewalkers.genshi
     :members:
-    :undoc-members:
     :show-inheritance:
+    :special-members: __init__