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.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d7782e1e685b91be4097ec2df5560bfdbe11c8ae6fb14ed7a1d1cf88d120e7e |
|
MD5 | be61f20750c09b4e3240a262157e4b3d |
|
BLAKE2b-256 | 826696f230573c73fc96ecceee1bfd4bf8ad9802e08468bcb9599c920615c67b |
Close
Hashes for django_sphinx_hosting-1.1.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f44d5eeb7fe078f41768f3e08896c70ae2a4057169f52a1b681288f361f371fc |
|
MD5 | 59c1f28587f0305ae55b31ca1fced790 |
|
BLAKE2b-256 | 4138e3573059bc125658c5cb56e93aae0aebaf518b012a0db984b4869fcb0ace |