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
Built Distribution
Close
Hashes for django-sphinx-hosting-1.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3cf3202ea8dd9de621ce6938ecc1cc96e1533f7c87410bc1c80219ecdb5098f0 |
|
MD5 | a337db6224b8086e7b59bed7b175e173 |
|
BLAKE2b-256 | d173aafcab9e07402f5de46274b851b8b6a65ab4b14a4d8afd08ff19f21a1227 |
Close
Hashes for django_sphinx_hosting-1.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed1c076eb5b1d4911d1e187cecace47c3508e293e29ee014cc86ae6b4d96c0ad |
|
MD5 | b9fbf1cf3a820dbc5fff5cb9aaede818 |
|
BLAKE2b-256 | a226f62d232a44748a2a0246a4d95a9953c7f88a52b01989ec218911801e5f21 |