Skip to content

Commit 482b0ac

Browse files
committed
update documentation
1 parent 646d2cd commit 482b0ac

File tree

2 files changed

+9
-11
lines changed

2 files changed

+9
-11
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@
1919
.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
2020
:target: https://saythanks.io/to/willforde
2121

22-
Why another Python HTML Parser?
23-
-------------------------------
22+
HTMLement
23+
---------
2424

25-
There is no "HTML Parser" in the "Python" Standard Library.
25+
Why another Python HTML Parser? There is no "HTML Parser" in the "Python" Standard Library.
2626
Actually, there is the `html.parser.HTMLParser`_ that simply "traverses the DOM tree" and allows me to be notified as
2727
each tag is being parsed. Usually, when "parsing HTML" I want to query its elements and extract data from it.
2828

docs/index.rst

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
htmlement Module
7-
================
6+
Welcome to HTMLement's documentation!
7+
=====================================
88

99
.. include::
1010
../README.rst
@@ -18,12 +18,10 @@ API
1818
.. automodule:: htmlement
1919
:members:
2020

21-
References
22-
----------
23-
https://docs.python.org/2/library/xml.etree.elementtree.html#element-objects
21+
External Links
22+
--------------
23+
ElementTree: https://docs.python.org/2/library/xml.etree.elementtree.html
2424

25-
https://docs.python.org/2/library/xml.etree.elementtree.html#xpath-support
26-
27-
https://github.com/willforde/python-htmlement
25+
Bug Tracker: https://github.com/willforde/python-htmlement/issues
2826

2927
.. _examples.py: https://github.com/willforde/python-htmlement/blob/master/examples.py

0 commit comments

Comments
 (0)