aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
blob: adb3d2dc200e6c19664a14b10cb9adf666bd390d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
================
RuSTructuredText
================

Designed around the `Docutils Document Tree`_ and the `reStructuredText specification`_, this is supposed to become a library able to convert reStructuredText and Docutils XML to both each other and HTML5.

This project is dual-licensed under Apache 2.0 and MIT.

.. _Docutils Document Tree: http://docutils.sourceforge.net/docs/ref/doctree.html
.. _reStructuredText specification: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html

.. note::
   If you are looking for the requirements tracking tool rst (Requirements, Specifications and Tests), have a look at the rst_app package instead.

Inspiration
-----------
The design was inspired by the comrak_ Markdown parser library. The rST grammar was adapted from peg-rst_

.. _comrak: https://github.com/kivikakk/comrak
.. _peg-rst: https://github.com/hhatto/peg-rst