django-sphinxdoc / README.txt

django-sphinxdoc – Embed your Sphinx docs into your Django site

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

Django-sphinxdoc can handle multiple Sphinx projects and offers a `Haystack
<>`_ powered search. Future versions will enable
comments and add RSS feeds.


This app requires Django >= 1.4.2, Sphinx >= 1.0 and Haystack >= 2.1.


Just use `PIP <>`_:

.. sourcecode:: bash

    $ pip install django-sphinxdoc

If you want the lates development version, isntall it from Bitbucket:

.. sourcecode:: bash

    $ pip install
    $ # or
    $ hg clone ssh://
    $ pip install -e django-sphinxdoc


The Documentation can be found in the *docs/* directory or
`online <>`_.