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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ceae5212d130498649d278003867da99b112f545c61f6f7db2e62dbef8c73941 |
|
MD5 | f6e5c6e115d53d1bce85a40595726c91 |
|
BLAKE2b-256 | 092ef8cbae7d94828994475859773ef0f91ef41432c975088ab91d9178e8d610 |
Close
Hashes for django_sphinx_hosting-1.3.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 790b05ac0a72786aa7160612f276ce0b028f23f67fa5c2cad3271190e4031a88 |
|
MD5 | e0b5671f8edb1e85793fefa8b84e09c3 |
|
BLAKE2b-256 | dcf8b791febc282023b993d9605416b13822f7099220159d5919ce792e5091df |