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.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-sphinxdoc-0.3.2.tar.gz.
File metadata
- Download URL: django-sphinxdoc-0.3.2.tar.gz
- Upload date:
- Size: 12.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
076f28a04a2d2328018365a81e9932fd770de1e7d09121b98086c27156050e0c
|
|
| MD5 |
d9cb944517b3e202bbbb07ee97659875
|
|
| BLAKE2b-256 |
0fac26d6a7b32633a13c6f8408f0eef57394e3a4df629c8a1200ae92c0eda98a
|
