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.2.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a15937f6edd18b81160ea534e7370b8054a99899b07f7d01e858b65e449779ff |
|
MD5 | 699a8e06302d0025c601af5cbd4bb23d |
|
BLAKE2b-256 | 5cdda0230364737a4f9d8c4a854173afb861c9c944e1b20b1fc2eee9ed02ce47 |
Close
Hashes for django_sphinx_hosting-1.2.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 875512fd471d1b8a2286baff4288416fe885f2e0d230584272c04bccccc9f041 |
|
MD5 | 7ea37fb13cebb81c3a5244121405ed64 |
|
BLAKE2b-256 | 36662cad7907c919ff5cc984a910d512a2bb9707cb10798f53a1c96bee320efd |