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.4.tar.gz
(100.9 kB
view hashes)
Built Distribution
Close
Hashes for django-sphinx-hosting-1.3.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d9a82b9748d8117cc68982e7cee38a361f2d14e1f6321aad711aae2286cba57 |
|
MD5 | 852011bb1c3a483e0c5fde14f55f65a5 |
|
BLAKE2b-256 | 38f01c5ca9b50227ebcd18f6fd70335c371008b230ce920170a9d41eaca536f7 |
Close
Hashes for django_sphinx_hosting-1.3.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 92d7edabd599ecd7b7032f38fda7e2d48b1c9215829404b416292d5203df241f |
|
MD5 | aa88b45a7efbda81101db7b922bebcbf |
|
BLAKE2b-256 | 77dfe540d8075a24b3e0dd8fa5b7299810129bb9b1c55b7a9ce2f3f05ed9eb23 |