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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 898518f85b9f5c9f1bf559f18a08ee56526699bfb15c337bddf78a0300655921 |
|
MD5 | 2d4eb2c7e69a115d4ce45ce55bddf842 |
|
BLAKE2b-256 | 566ef399522bf1e287096078e760c324b41af8fc74c1aca81f75dd01fea9e3a6 |
Close
Hashes for django_sphinx_hosting-1.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 617ce534ff51956d6edb093984781fd8d6d958fe433ed708c4ce12e3af4ccef9 |
|
MD5 | 87a51e9a287dbc97089e673a93dfbb8e |
|
BLAKE2b-256 | 35d034d57964d1c3d6cf9653bf9899b3953132266114e2358011be882d6d1373 |