Skip to main content

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/.

Metadata

Release files for django-sphinxdoc 2.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-sphinxdoc 2.0.0
File Size Uploaded Provenance
django-sphinxdoc-2.0.0.tar.gz 179.0 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for django-sphinxdoc 2.0.0
File Interpreter ABI Platform
django_sphinxdoc-2.0.0-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 195.0 kB

Release files / django-sphinxdoc-2.0.0.tar.gz

Download URL django-sphinxdoc-2.0.0.tar.gz
Size 179.0 kB
Tags Source
SHA-256 checksum
How to use checksums
f2840cbe7186acec4558fbeb2a6d7dfb64d25b9784e6840fadd32e1ccf1f9e37
BLAKE2b-256 checksum
How to use checksums
915cfeb1a2630f2b5ac948e008526e91c1936e27a84644776cbf59819e5aad8e
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / django_sphinxdoc-2.0.0-py2.py3-none-any.whl

Download URL django_sphinxdoc-2.0.0-py2.py3-none-any.whl
Size 16.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
ac0ab76366e66e9ce7e46eaccb2f91b386d9c0da53c9ab15e802352c76e6747b
BLAKE2b-256 checksum
How to use checksums
16ae8328a552f02440efdaa01aac846b08e671f78801727d57d7a9eccc80d819
Upload date
Uploaded using Trusted Publishing?
What is 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

Security for django-sphinxdoc 2.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page