A Python parser for MediaWiki wikicode https://mwparserfromhell.readthedocs.io/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

54 lines
1.6 KiB

  1. MWParserFromHell v0.2 Documentation
  2. ===================================
  3. :py:mod:`mwparserfromhell` (the *MediaWiki Parser from Hell*) is a Python
  4. package that provides an easy-to-use and outrageously powerful parser for
  5. MediaWiki_ wikicode. It supports Python 2 and Python 3.
  6. Developed by Earwig_ with help from `Σ`_.
  7. .. _MediaWiki: http://mediawiki.org
  8. .. _Earwig: http://en.wikipedia.org/wiki/User:The_Earwig
  9. .. _Σ: http://en.wikipedia.org/wiki/User:%CE%A3
  10. Installation
  11. ------------
  12. The easiest way to install the parser is through the `Python Package Index`_,
  13. so you can install the latest release with ``pip install mwparserfromhell``
  14. (`get pip`_). Alternatively, get the latest development version::
  15. git clone git://github.com/earwig/mwparserfromhell.git
  16. cd mwparserfromhell
  17. python setup.py install
  18. If you get ``error: Unable to find vcvarsall.bat`` while installing, this is
  19. because Windows can't find the compiler for C extensions. Consult this
  20. `StackOverflow question`_ for help. You can also set ``ext_modules`` in
  21. ``setup.py`` to an empty list to prevent the extension from building.
  22. You can run the comprehensive unit testing suite with ``python setup.py test``.
  23. .. _Python Package Index: http://pypi.python.org
  24. .. _get pip: http://pypi.python.org/pypi/pip
  25. .. _StackOverflow question: http://stackoverflow.com/questions/2817869/error-unable-to-find-vcvarsall-bat
  26. Contents
  27. --------
  28. .. toctree::
  29. :maxdepth: 2
  30. usage
  31. integration
  32. changelog
  33. API Reference <api/modules>
  34. Indices and tables
  35. ------------------
  36. * :ref:`genindex`
  37. * :ref:`modindex`
  38. * :ref:`search`