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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 36014fff35740e05ce488c7da60af5e39cca23b83cc74b2eee9d7ad9569ef34a |
|
MD5 | cb815ed30c66d30f219f94e681673b0b |
|
BLAKE2b-256 | 666fa96c26b49360cff62720b25a6fe7db3118038a4acfdb860118a50f0ff6a0 |
Close
Hashes for django_sphinx_hosting-1.1.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d169f1e0069477905a21940e6d0d115f5033ba361463b1ac97745b9ed77dec50 |
|
MD5 | 76194e1209137fe98c6cdbbf3a8fb6cb |
|
BLAKE2b-256 | 006815a93964eaba8748985521245132121d19bad6f2cf5fde2dcc3f8e7a65a2 |