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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 160d214f1fc5368f19d34f23751adaafc410222ac9adb158aabe002c8fcf7b07 |
|
MD5 | 0a6d6c9726854c766fe7151744605616 |
|
BLAKE2b-256 | 7d71d174deefdc6ffe0d0f12ada5a9ee17e423650adca9928798bd7df2b03691 |
Close
Hashes for django_sphinx_hosting-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 17922b07cd2a14d02b188de13c6802d4ac6b66f6f74459f03c9b98e78f4c4f35 |
|
MD5 | 500250272d73c6b428325b8fccd6d8c8 |
|
BLAKE2b-256 | 088a806e465dcdd955f4e34d58d3605ce17e316dacb80b047fbad677226f73a7 |