Browse Source

Some documentation cleanup.

tags/v0.3
Ben Kurtovic 10 years ago
parent
commit
7b6b46da95
4 changed files with 29 additions and 11 deletions
  1. +10
    -2
      CHANGELOG
  2. +3
    -1
      README.rst
  3. +14
    -6
      docs/changelog.rst
  4. +2
    -2
      docs/index.rst

+ 10
- 2
CHANGELOG View File

@@ -1,4 +1,8 @@
v0.1.1 (19da4d2144) to v0.2 (edf6a3a8a6):
v0.3 (unreleased):

- Various fixes and cleanup.

v0.2 (released June 20, 2013):

- The parser now fully supports Python 3 in addition to Python 2.7.
- Added a C tokenizer extension that is significantly faster than its Python
@@ -24,10 +28,14 @@ v0.1.1 (19da4d2144) to v0.2 (edf6a3a8a6):
- Fixed some broken example code in the README; other copyedits.
- Other bugfixes and code cleanup.

v0.1 (ba94938fe8) to v0.1.1 (19da4d2144):
v0.1.1 (released September 21, 2012):

- Added support for Comments (<!-- foo -->) and Wikilinks ([[foo]]).
- Added corresponding ifilter_links() and filter_links() methods to Wikicode.
- Fixed a bug when parsing incomplete templates.
- Fixed strip_code() to affect the contents of headings.
- Various copyedits in documentation and comments.

v0.1 (released August 23, 2012):

- Initial release.

+ 3
- 1
README.rst View File

@@ -9,7 +9,8 @@ mwparserfromhell
that provides an easy-to-use and outrageously powerful parser for MediaWiki_
wikicode. It supports Python 2 and Python 3.

Developed by Earwig_ with help from `Σ`_.
Developed by Earwig_ with help from `Σ`_. Full documentation is available on
ReadTheDocs_.

Installation
------------
@@ -142,6 +143,7 @@ following code (via the API_)::
return mwparserfromhell.parse(text)

.. _MediaWiki: http://mediawiki.org
.. _ReadTheDocs: http://mwparserfromhell.readthedocs.org
.. _Earwig: http://en.wikipedia.org/wiki/User:The_Earwig
.. _Σ: http://en.wikipedia.org/wiki/User:%CE%A3
.. _Python Package Index: http://pypi.python.org


+ 14
- 6
docs/changelog.rst View File

@@ -1,10 +1,19 @@
Changelog
=========

v0.3
----

Unreleased
(`changes <https://github.com/earwig/mwparserfromhell/compare/v0.2...develop>`__):

- Various fixes and cleanup.

v0.2
----

19da4d2144_ to edf6a3a8a6_ (released June 20, 2013)
`Released June 20, 2013 <https://github.com/earwig/mwparserfromhell/tree/v0.2>`_
(`changes <https://github.com/earwig/mwparserfromhell/compare/v0.1.1...v0.2>`__):

- The parser now fully supports Python 3 in addition to Python 2.7.
- Added a C tokenizer extension that is significantly faster than its Python
@@ -38,7 +47,8 @@ v0.2
v0.1.1
------

ba94938fe8_ to 19da4d2144_ (released September 21, 2012)
`Released September 21, 2012 <https://github.com/earwig/mwparserfromhell/tree/v0.1.1>`_
(`changes <https://github.com/earwig/mwparserfromhell/compare/v0.1...v0.1.1>`__):

- Added support for :py:class:`Comments <.Comment>` (``<!-- foo -->``) and
:py:class:`Wikilinks <.Wikilink>` (``[[foo]]``).
@@ -51,8 +61,6 @@ ba94938fe8_ to 19da4d2144_ (released September 21, 2012)
v0.1
----

ba94938fe8_ (released August 23, 2012)
`Released August 23, 2012 <https://github.com/earwig/mwparserfromhell/tree/v0.1>`_:

.. _edf6a3a8a6: https://github.com/earwig/mwparserfromhell/tree/v0.2
.. _19da4d2144: https://github.com/earwig/mwparserfromhell/tree/v0.1.1
.. _ba94938fe8: https://github.com/earwig/mwparserfromhell/tree/v0.1
- Initial release.

+ 2
- 2
docs/index.rst View File

@@ -1,5 +1,5 @@
MWParserFromHell v0.3 Documentation
===================================
MWParserFromHell v\ |version| Documentation
===========================================

:py:mod:`mwparserfromhell` (the *MediaWiki Parser from Hell*) is a Python
package that provides an easy-to-use and outrageously powerful parser for


Loading…
Cancel
Save