Skip to main content

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

Project details


Download files

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

Source Distribution

django-sphinxdoc-2.0.0.tar.gz (179.0 kB view hashes)

Uploaded source

Built Distribution

django_sphinxdoc-2.0.0-py2.py3-none-any.whl (16.0 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page