Skip to main content

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 is tested with Django >= 1.1. You also need Sphinx >= 1.0 and Haystack.

Installation

You can either install this app with PIP:

$ pip install django-sphinxdoc

or download and install it manually:

$ cd where/you/put/django-sphinxdoc/
$ python setup.py install

Use this URL for cloning if you want to install this app in development mode.

Usage

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

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

Uploaded Source

File details

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

File metadata

  • Download URL: django-sphinxdoc-1.1.tar.gz
  • Upload date:
  • Size: 517.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-sphinxdoc-1.1.tar.gz
Algorithm Hash digest
SHA256 7ac8fa4003a332e1d1c15c79a008dd75e479e68c41cd3c57f698147d67ef7b20
MD5 c0609cdb11412f933d4fa500cf38fd56
BLAKE2b-256 6a5a5f2f5b8ba2e195d2f62a8eb0106cd25c6dfaec3f08232053b9dc30385c23

See more details on using hashes here.

Supported by

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