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
django-sphinx-hosting-1.4.1.tar.gz
(102.0 kB
view hashes)
Built Distribution
Close
Hashes for django-sphinx-hosting-1.4.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0a9700ce4e53af64937c30d4231170458f28665aa2b0eb8438a2c4dd530ac052 |
|
MD5 | 6ff6bf40da18eb41b35ca89d03b77aa8 |
|
BLAKE2b-256 | 5e9a09096f50524851c177fc3e840062e2483def001fa504f61f3aece9a76b8b |
Close
Hashes for django_sphinx_hosting-1.4.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e12f1a030ec047c78393c158a06ee03b2bf717e7b1a25571e57fdf3dd4e24f03 |
|
MD5 | f12323e69e943cbe5e14d18ab46dcb47 |
|
BLAKE2b-256 | 965d2f872f8c846ba9d915702621a10b81626aa8aa97bd22b4c2ecd0ebc31282 |