Skip to content

Commit

Permalink
Update the docs after all the renaming and add CHANGES
Browse files Browse the repository at this point in the history
  • Loading branch information
gsnedders committed Jul 14, 2016
1 parent 00977d6 commit 8cb144b
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 67 deletions.
14 changes: 14 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,20 @@ Released on XXX
with a set of keyword arguments: override_encoding, transport_encoding,
same_origin_parent_encoding, likely_encoding, and default_encoding.**

* **Move filters._base, treebuilder._base, and treewalkers._base to .base
to clarify their status as public.**

* **Get rid of the sanitizer package. Merge sanitizer.sanitize into the
sanitizer.htmlsanitizer module and move that to saniziter. This means
anyone who used sanitizer.sanitize or sanitizer.HTMLSanitizer needs no
code changes.**

* **Rename treewalkers.lxmletree to .etree_lxml and
treewalkers.genshistream to .genshi to have a consistent API.**

* Move a whole load of stuff (inputstream, ihatexml, trie, tokenizer,
utils) to be underscore prefixed to clarify their status as private.


0.9999999/1.0b8
~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions doc/html5lib.filters.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
filters Package
===============

:mod:`_base` Module
:mod:`base` Module
-------------------

.. automodule:: html5lib.filters._base
.. automodule:: html5lib.filters.base
:members:
:undoc-members:
:show-inheritance:
Expand Down
37 changes: 2 additions & 35 deletions doc/html5lib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,42 +25,10 @@ html5lib Package
:undoc-members:
:show-inheritance:

:mod:`ihatexml` Module
:mod:`serializer` Module
----------------------

.. automodule:: html5lib.ihatexml
:members:
:undoc-members:
:show-inheritance:

:mod:`inputstream` Module
-------------------------

.. automodule:: html5lib.inputstream
:members:
:undoc-members:
:show-inheritance:

:mod:`sanitizer` Module
-----------------------

.. automodule:: html5lib.sanitizer
:members:
:undoc-members:
:show-inheritance:

:mod:`tokenizer` Module
-----------------------

.. automodule:: html5lib.tokenizer
:members:
:undoc-members:
:show-inheritance:

:mod:`utils` Module
-------------------

.. automodule:: html5lib.utils
.. automodule:: html5lib.serializer
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -71,7 +39,6 @@ Subpackages
.. toctree::

html5lib.filters
html5lib.serializer
html5lib.treebuilders
html5lib.treewalkers

19 changes: 0 additions & 19 deletions doc/html5lib.serializer.rst

This file was deleted.

4 changes: 2 additions & 2 deletions doc/html5lib.treebuilders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ treebuilders Package
:undoc-members:
:show-inheritance:

:mod:`_base` Module
:mod:`base` Module
-------------------

.. automodule:: html5lib.treebuilders._base
.. automodule:: html5lib.treebuilders.base
:members:
:undoc-members:
:show-inheritance:
Expand Down
19 changes: 10 additions & 9 deletions doc/html5lib.treewalkers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ treewalkers Package
:undoc-members:
:show-inheritance:

:mod:`_base` Module
:mod:`base` Module
-------------------

.. automodule:: html5lib.treewalkers._base
.. automodule:: html5lib.treewalkers.base
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -33,18 +33,19 @@ treewalkers Package
:undoc-members:
:show-inheritance:

:mod:`genshistream` Module
--------------------------
:mod:`etree_lxml` Module
-----------------------

.. automodule:: html5lib.treewalkers.genshistream
.. automodule:: html5lib.treewalkers.etree_lxml
:members:
:undoc-members:
:show-inheritance:

:mod:`lxmletree` Module
-----------------------

.. automodule:: html5lib.treewalkers.lxmletree
:mod:`genshi` Module
--------------------------

.. automodule:: html5lib.treewalkers.genshi
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:

0 comments on commit 8cb144b

Please sign in to comment.