Skip to main content

Easily integrate Sphinx documentation into your website.

Project description

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/sscherfke/django-sphinxdoc
$ # or
$ hg clone ssh://hg@bitbucket.org/sscherfke/django-sphinxdoc
$ pip install -e django-sphinxdoc

Usage

The Documentation can be found in the docs/ directory.

Changelog for django-sphinxdoc

v1.4 – 2014-12-14:

  • [NEW] Support for Python 3 (3.3 and above)

v1.3 – 2014-03-05:

  • [NEW] Projects can now be protected authentication.

v1.2.1 – 2013-12-20:

  • [NEW] Option --all to update docs for all projects

  • [NEW] Filters for the project admin

  • [NEW] Setting: SPHINXDOC_CACHE_MINUTES

  • [NEW] Setting: SPHINXDOC_BUILD_DIR

  • [FIX] Titles for generated domain indexes

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:

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.4.0.tar.gz (410.6 kB view details)

Uploaded Source

Built Distribution

django_sphinxdoc-1.4.0-py2.py3-none-any.whl (17.7 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for django-sphinxdoc-1.4.0.tar.gz
Algorithm Hash digest
SHA256 3a5edd001a97ae92eaf178cb2070cc49c5ac834e84928b04019a82b88058bdbd
MD5 37af36a704ec5108435b3f62b8c87d6d
BLAKE2b-256 1b408a4b4993a08b38ce1b96ab3dd33cac271478c44f08da14460755b65202b5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_sphinxdoc-1.4.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 257672f362154c875dc95ed4c4e7b49eae249bb9b8c2f102bf27255c6e18ad47
MD5 526a419db103e5ece35b3631832badef
BLAKE2b-256 bcfd0cd7a1e96d8cdd0a0371f726a8474f071fa59bfa114926aad0045551c43b

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