Versions

Build a version

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.

Repository

https://bitbucket.org/sscherfke/django-sphinxdoc/

Last Built

1 month, 3 weeks ago failed

Owners

Home Page

https://bitbucket.org/sscherfke/django-sphinxdoc/

Badge

Tags

sphinx, django

Project Privacy Level

Public

Short URLs

django-sphinxdoc.readthedocs.io
django-sphinxdoc.rtfd.io

Default Version

latest

'latest' Version

default