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.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-sphinxdoc-0.3.2.tar.gz (12.7 kB) Copy SHA256 hash SHA256 Source None Mar 14, 2010

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page