Skip to main content

Simple Django application to parse content with ReStructuredText from docutils

Project description

Introduction

This is a simple Django application to parse content with ReStructuredText from docutils to HTML5 or HTML4 (suitable for XHTML).

Requires

Optionnaly (but recommended) you can install Pygments to have highlighted syntax in your sourcecode block :

Installation

Just register the app in your project settings like this :

INSTALLED_APPS = (
    ...
    'rstview',
    ...
)

If needed you can change some options, see the “local_settings.py” file to find the available option variables and overwrite them in your project settings file.

Usage

Simpliest usage is to display a ReStructuredText file, like a “README.rst” from a project, assuming the file is a path below your Django project, you can add it to your project “urls.py” file like this :

...
from rstview.views import RSTFileView
...
urlpatterns = patterns('',
    ...
    url(r'^README$', RSTFileView.as_view(doc_file_path="../README.rst", doc_title="Notice"), name='project-readme'),
    ...
)

Default settings is to render document as HTML5, you can change this behaviour to a HTML4 render that is also suitable to use in XHTML documents, see local_settings.RSTVIEW_PARSER_WRITER and override it in settings.RSTVIEW_PARSER_WRITER.

RSTFileView

This generic view takes three optional arguments :

  • doc_file_path : the file path to parse as ReStructuredText file to render;

  • doc_title : the title for the document;

  • template_name : a custom template file path, by default this is rstview/fileview.html.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rstview-0.1.1.tar.gz (8.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page