Skip to main content

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:

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

django-sphinxdoc-1.2.0.tar.gz (606.3 kB view details)

Uploaded Source

Built Distribution

django_sphinxdoc-1.2.0-py2.py3-none-any.whl (15.7 kB view details)

Uploaded Python 2Python 3

File details

Details for the file django-sphinxdoc-1.2.0.tar.gz.

File metadata

File hashes

Hashes for django-sphinxdoc-1.2.0.tar.gz
Algorithm Hash digest
SHA256 8ed7134db3c2dfbbb64f4607a61ffa38aeff6f17f18d888bc2689e3e86f0ff92
MD5 4e2d5023a72d968dafd7ab7440b53fd8
BLAKE2b-256 c9442e2f12e7d778e6a1a64e812e9f37eaaf0d1bab6e661da705ff550cccdfb9

See more details on using hashes here.

File details

Details for the file django_sphinxdoc-1.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_sphinxdoc-1.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 71147b831a2541fa475572d7cfcfa139a33ece58e41719c8d42f344fdc8bd32b
MD5 56278f7248e03278f54eab9c43e1da5f
BLAKE2b-256 07e3e13c203d9fa806f107edafa3a53ea9837d49ea63c5701aa19b98e22bb05e

See more details on using hashes here.

Supported by

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