Reusable Django app for hosting Sphinx documentation privately.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for caltechads from gravatar.com caltechads Avatar for cmalek from gravatar.com cmalek

Unverified details

These details have not been verified by PyPI
Project links
Meta
Classifiers

Project description

django-sphinx-hosting

Documentation: django-sphinx-hosting.readthedocs.org

This reusable Django application provides models, views, permissions, REST API endpoints and management commands for making a private Sphinx documentation hosting platform.

This is useful for when you want Sphinx documentation for your internal software projects, but that is too sensitive to be shared with a third party.

Features

  • Users must be authenticated to view docs
  • Multiple levels of privileges within the system based on Django authentication
  • Manage multiple versions of your docs per project
  • Automatically build and display navigation for each version of your documentaion
  • Renders all documentation published within with a consistent theme
  • Tag projects with classifiers to refine searching and filtering
  • Search across all projects
  • Use REST API to programmatically interact with the system. Useful for integrating into a CI/CD system

Installation and Configuration

See the documentation for how to install and configure django-sphinx-hosting in your Django project.

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