django-sphinxdoc /

Filename Size Date modified Message
docs
sphinxdoc
71 B
328 B
198 B
1.2 KB
1.5 KB
79 B
1.1 KB
1.1 KB

Django and Sphinx documentation

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.

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.