django-sphinxdoc /

Filename Size Date modified Message
docs
sphinxdoc
128 B
182 B
119 B
366 B
1.5 KB
79 B
1.3 KB
1.0 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.

It’s based on Django’s documentation app and makes it more widely usable.

django-sphinxdoc can handle multiple Sphinx projects (called “apps” from now on). It takes the static body of the documentation from the JSON files Sphinx creates and embeds them in the content block of your site.

Requirements

This app is tested with Django 1.1. It might also work with older versions, but I haven’t tested it.

There are no other requirements.

Installation

If you read this, you have probably managed to extract the archive containing these files. Next, open a Terminal and cd to the directory containing this file (e.g. cd ~/Downloads/django-sphinxdoc). Then execute:

python setup.py install

If you checked out the repository and always want to use the newest version, type:

pip install -e path/to/django-sphinxdoc

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.