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/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.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 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.3.0.tar.gz (408.4 kB view details)

Uploaded Source

Built Distribution

django_sphinxdoc-1.3.0-py2.py3-none-any.whl (16.3 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for django-sphinxdoc-1.3.0.tar.gz
Algorithm Hash digest
SHA256 8e40b9bbadcd019b0575d5c378d88d4a051617d7571b947a1aec98fbea5a8e53
MD5 333b490b1f6abd451a9a88d6367887ef
BLAKE2b-256 2c917cd2141444929f1d794145870eabc38a916b97e5f89d55c0d99297e3ea23

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_sphinxdoc-1.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1942f6cf4911e384e2aa87629f7d146a0200c605c934b3dfd5360bb3b74907bf
MD5 a5b0b8f6e1ec7a59e17ceb5d550145ff
BLAKE2b-256 465e9ef2ea90d85e627dd6873dc08a83bcf42de38abf1e8ce528ab23c860deb6

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