django-sphinxdoc 1.2.0

Easily integrate Sphinx documentation into your website.

Requirements

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

Installation

Just use PIP:

$ pip install django-sphinxdoc

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

$ pip install https://ssc@bitbucket.org/ssc/django-sphinxdoc
$ # or
$ hg clone ssh://hg@bitbucket.org/ssc/django-sphinxdoc
$ pip install -e django-sphinxdoc

Usage

The Documentation can be found in the docs/ directory or online.

v1.2 – 2013-08-11:

• [NEW] I18n and l10n for Spanish and Basque, by Ales Zabala Alava
• [CHANGE] Use class-based views, by Josiah Klassen

- [CHANGE] Migration to Haystack 2, by Andres Riancho – [FIX] Inclusion of search index template in package, by Mike Shantz

v1.1 – 2012-04-19:

• [NEW] Support static and download files.
• [NEW] Additional context to search view so that project information is available in the template.
• [CHANGE] Updated some templates
• [FIX] Fixed a bug with the updatedoc command and ~ in paths.
• [FIX] Include all module index files.
• [FIX] Improved indexing behaviour
• [FIX] Improved behaviour when building the docs.

v1.0.0 – 2010-09-11:

• [NEW] Documentation can be searched via Haystack. The new management command updatedoc imports the JSON files into the database and updates Haystack’s search index.
• [CHANGE] Renamed App to Project.

v0.3.2 – 2010-03-14:

• [FIX] Fixed a bug in setup.py.

v0.3.1 – 2010-03-11:

• [CHANGE] Repackaging

v0.3 – 2010-01-06:

• [NEW] Views for images, sources and object inventory

v0.2 – 2009-12-30:

• [NEW] Documentation, general index and module index work
• [NEW] Basic documentation written

v0.1 – 2009-12-19:

• [NEW] Initial release