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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52ac33074d645e09aa681792d74b45846fb1c0842013c15e8865b7981502d234 |
|
MD5 | 8379ab73a56b47b1fe1f77bd19007b98 |
|
BLAKE2b-256 | 3b34e824c9792fc257fea776fec0fd5020753834903f5286bd192593baf9bcb5 |
Close
Hashes for django_sphinx_hosting-1.3.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d5105e1dd702aa834cc074b33d178f956155da802d2801dcf2068be1af7b846b |
|
MD5 | ff4bb6a9b6f9c7630bfecc6a4f77e1c1 |
|
BLAKE2b-256 | e2b8a934a0b584a7824985c2dc8743886be79015572a890f66b5ec0c6298bece |