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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b3469868aca9a639d7df300f4b8ac5d06e89d3147920d0e033c61d6673c8227d |
|
MD5 | c6e3605d496c1911131b5bcc93a5ce9a |
|
BLAKE2b-256 | 5c17e2f19652f8d38e5947f0883d24b6b20d5ecee056f23d59c2e63cdbd51e64 |
Close
Hashes for django_sphinx_hosting-1.3.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | faba7868993d487fa6bfab714937a30127369b2367b5ea2b3149ba294e73bc5c |
|
MD5 | 7ac97bed96b565f6643f729fc3d46af5 |
|
BLAKE2b-256 | 19955e1f83ea7050c8daed8ac24119c446ed3903883c6ff270a372440995cb51 |