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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 73b2b1f92ccc06f6f7202135000f66739abcc7e0c493d52d70420a9fb47cb266 |
|
MD5 | ad6e29dd39a9ea1bf76734061d994695 |
|
BLAKE2b-256 | cbbc739b86f57e59728beeace8ab9c2b73efc22a59de856f502eb3023d08ea95 |
Close
Hashes for django_sphinx_hosting-1.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dd134547312ad28f731e76ea6cbcf9eb783107d330a56b3d31c108d4eb8a7f4f |
|
MD5 | 0129e6abd476c781304c3f7cf0f641f0 |
|
BLAKE2b-256 | da0652a02c8202ea63d37eb479534e171ad065836a00b18ce8f72f7d5f40fb48 |