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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 591f6d41fd5570a49f3ac5c71441e2663278c262eefa22f95721a1e0f8ef77e3 |
|
MD5 | 65f3da40079ac1e40abc3b766b1c2aca |
|
BLAKE2b-256 | 8ef990f0b09e47a0a08fc19fb713e4261b2ee579a5c853f044f1b086e1d9422b |
Close
Hashes for django_sphinx_hosting-1.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7972f88c86a73b92159f48cd0f77c17d9590f7d490eb6e8f7c80d51701fb3666 |
|
MD5 | 34a2d0a2727080151e3c89c76d8272a9 |
|
BLAKE2b-256 | cb0dfbe263084f6f6d192b669210f8a296d9669cefd6d905394f0ee71943ba19 |