Easily integrate Sphinx documentation into your website.
Project description
django-sphinxdoc – Embed your Sphinx docs into your Django site
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.
Requirements
This app requires Python ≥ 3.6, Django ≥ 2.0, Sphinx ≥ 1.0 and Haystack ≥ 2.8.0.
Installation
Just use PIP:
$ pip install django-sphinxdoc
If you want the latest development version:
$ git clone git@gitlab.com:sscherfke/django-sphinxdoc.git
$ cd django-sphinxdoc
$ mkvirtualenv django-sphinxdoc
$ pip install -e .
Usage
The documentation can be found in the docs/ directory or at
https://django-sphinxdoc.readthedocs.io/en/latest/.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file django-sphinxdoc-2.0.0.tar.gz.
File metadata
- Download URL: django-sphinxdoc-2.0.0.tar.gz
- Upload date:
- Size: 179.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f2840cbe7186acec4558fbeb2a6d7dfb64d25b9784e6840fadd32e1ccf1f9e37 |
|
| MD5 | cb811d266ca95b449715d62113d91f4f |
|
| BLAKE2b-256 | 915cfeb1a2630f2b5ac948e008526e91c1936e27a84644776cbf59819e5aad8e |
File details
Details for the file django_sphinxdoc-2.0.0-py2.py3-none-any.whl.
File metadata
- Download URL: django_sphinxdoc-2.0.0-py2.py3-none-any.whl
- Upload date:
- Size: 16.0 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ac0ab76366e66e9ce7e46eaccb2f91b386d9c0da53c9ab15e802352c76e6747b |
|
| MD5 | 88d2792fbef1fd99c3bd4259ccba1982 |
|
| BLAKE2b-256 | 16ae8328a552f02440efdaa01aac846b08e671f78801727d57d7a9eccc80d819 |
