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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5b1805f4f08b4ff0afa68b23823ae68a3f53410006ed656c0c4b32fe2f313f2f |
|
MD5 | b4893acfa0b6c3f36d58abc769cc53cb |
|
BLAKE2b-256 | ad28b173ebccaa506ed039ac701748871693009f9f238e8429a4ebe8c5b59acc |
Close
Hashes for django_sphinx_hosting-1.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50f0957e9391bf68cc2c07703de6e7955987c2efcf212b01f0b8c63861342467 |
|
MD5 | 7ee13d9aa3c534e71d65fdd3de0e693d |
|
BLAKE2b-256 | a3d30f99cdf444ef0f9a8131bfcec0d6bba7522f1fee835dd587901a86f83758 |