Skip to main content
Help us improve Python packaging – donate today!

Easily integrate Sphinx documentation into your website.

Project Description

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.

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.

Changelog for django-sphinxdoc

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

Authors

The primary author of django-sphinxdoc is Stefan Scherfke, who may be found online at http://stefan.sofa-rockers.org/.

Contributors since v1.0:

Contributors since v1.1:

Release history Release notifications

History Node

1.5.1

History Node

1.5.0

History Node

1.4.2

History Node

1.4.1

History Node

1.4.0

History Node

1.3.0

History Node

1.2.1

This version
History Node

1.2.0

History Node

1.1

History Node

1.0

History Node

0.3.2

History Node

0.3.1

History Node

0.2

History Node

0.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
django_sphinxdoc-1.2.0-py2.py3-none-any.whl (15.7 kB) Copy SHA256 hash SHA256 Wheel 2.7 Aug 11, 2013
django-sphinxdoc-1.2.0.tar.gz (606.3 kB) Copy SHA256 hash SHA256 Source None Aug 11, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page