Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
69 lines (50 sloc) 1.74 KB

Welcome to rstview's documentation!

This is a simple Django application around docutils to parse reStructuredText markup.

Features

  • Html4 and Html5 writers available;
  • Custom reporter to validate source;
  • Dedicated view to make a page from a rst source;
  • Template tag to directly parse reStructuredText markup;
  • Parser driven by configuration so they can be shared without to define them again and again;
  • Configuration registry to store multiple different parser configurations;
  • Test driven development;

Links

Dependancies

  • Django >= 1.7, <1.10;
  • docutils >= 0.7;
  • Optionnaly (but recommended): Pygments >= 1.2.x to have highlighted syntax in your sourcecode blocks;

User’s Guide

.. toctree::
   :maxdepth: 2

   install.rst
   library_references/templatetags.rst
   library_references/views.rst

References

.. toctree::
   :maxdepth: 1

   settings.rst
   library_references/registry.rst
   library_references/discover.rst
   library_references/parser.rst
   library_references/html5writer.rst

Developer’s Guide

.. toctree::
   :maxdepth: 1

   development.rst
   changelog.rst