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.5.tar.gz
(101.0 kB
view hashes)
Built Distribution
Close
Hashes for django-sphinx-hosting-1.3.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ec0733c2ed94a28bd5f8b530373e543039361d6753f10174e52bfa1ab6c5dd99 |
|
MD5 | 498dce79cb1e997b03ad2edfa820dcae |
|
BLAKE2b-256 | 984abd668a7ca7fe01e02e35143d45011dd71af5768bbe6cf81aba676cbf882a |
Close
Hashes for django_sphinx_hosting-1.3.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f1c89f0d4e0d7ca1c42f3bf4966c5192fa4bead0bc89244c3e8bd32d342ec83 |
|
MD5 | 79b6ffd99631be7ba2b71c4ba5f2648f |
|
BLAKE2b-256 | ecc7611b72f581337b87c0ced1aae0c189f0a41d483b9a771a73c9798e796824 |