Easily integrate Sphinx documentation into your website.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for scherfke from gravatar.com scherfke Avatar for sscherfke from gravatar.com sscherfke

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Stefan Scherfke
  • Requires: Python >=3.6
Classifiers

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

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page