Reusable Django app for hosting Sphinx documentation privately.
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.
Project details
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
django-sphinx-hosting-1.3.3.tar.gz
(100.2 kB
view hashes)
Built Distribution
Close
Hashes for django-sphinx-hosting-1.3.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bd4d656ead9085c7dfb27a5fdbb6f882dbb1f8ba79f0a11bf6a1e11d69f8f2c5 |
|
MD5 | 037cace6bed2e0d429688bc0f2787be3 |
|
BLAKE2b-256 | 9240a4464c80691894e086ccddccb104413c781dfd25a64d612dfa4bb5380f6e |
Close
Hashes for django_sphinx_hosting-1.3.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23e066e79e79d8d22acdf035de182917e9678d3335afe07027479d336b10189c |
|
MD5 | a078f39c6b2c19a9ffec244ead746f02 |
|
BLAKE2b-256 | 4dc8ddd15b22ed4dbdc26be8baacf7208448dc306aaa7e1c055a9022847dcf57 |