django-sphinxdoc / README.txt

Django and Sphinx documentation

This Django application allows you to integrate any `Sphinx
<>`_ documentation directly into your Django powered
website instead of just serving the static files.

It’s based on `Django’s documentation app
<>`_ and
makes it more widely usable.

django-sphinxdoc can handle multiple Sphinx projects (called „apps“ from now
on). It takes the static body of the documentation from the JSON files Sphinx
creates and embeds them in the content block of your site.


This app is tested with Django 1.1. It might also work with older versions, but
I haven’t tested it. 
`Setuptools <>`_ is required to install 
this app.

There are no other requirements.


If you read this, you have probably managed to extract the archive containing
these files. Next, open a Terminal and `cd` to the directory containing this
file (e.g. ``cd ~/Downloads/django-sphinxdoc``). Then execute::

    python install
If you checked out the repository and always want to use the newest version,

    python develop


Documentation on how to use this app can be found in the *docs/* directory.