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.0.tar.gz
(101.9 kB
view hashes)
Built Distribution
Close
Hashes for django-sphinx-hosting-1.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cbcc7f790b8d4572e8d07a1d3ce1ba70edb23ceb7b5e0b645fb052d9ac68f3f2 |
|
MD5 | 0368ef2849920f5fed1e2288fec46edc |
|
BLAKE2b-256 | 8084c0410a16f44dff02fe8deaf314ac1a302f320f6098a6d8d38466fda49c0f |
Close
Hashes for django_sphinx_hosting-1.4.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 26c56a04662d92fbacda0717f36b7b1bce617b55e551a52640c0647a64f74cb8 |
|
MD5 | a5d123c947e3254a69560b928e83bd62 |
|
BLAKE2b-256 | c5e10be0c376cc99646716b57719988df2723882f687d2f758cffa4958bc18c2 |