# django-sphinx-hosting
**Documentation**: [django-sphinx-hosting.readthedocs.org](https://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](https://django-sphinx-hosting.readthedocs.org) for how
to install and configure `django-sphinx-hosting` in your Django project.
Raw data
{
"_id": null,
"home_page": "https://github.com/caltechads/django-sphinx-hosting",
"name": "django-sphinx-hosting",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "documentation, sphinx, django",
"author": "Caltech IMSS ADS",
"author_email": "imss-ads-staff@caltech.edu",
"download_url": "https://files.pythonhosted.org/packages/f6/0a/d3f6f434b94a7dc0b98e3a3076feab036f97d855795fb0c908fcc5d4ed57/django-sphinx-hosting-1.5.1.tar.gz",
"platform": null,
"description": "# django-sphinx-hosting\n\n**Documentation**: [django-sphinx-hosting.readthedocs.org](https://django-sphinx-hosting.readthedocs.org)\n\nThis reusable Django application provides models, views, permissions, REST API\nendpoints and management commands for making a private Sphinx documentation\nhosting platform.\n\nThis is useful for when you want Sphinx documentation for your internal software\nprojects, but that is too sensitive to be shared with a third party.\n\n## Features\n\n* Users must be authenticated to view docs\n* Multiple levels of privileges within the system based on Django authentication\n* Manage multiple versions of your docs per project\n* Automatically build and display navigation for each version of your documentaion\n* Renders all documentation published within with a consistent theme\n* Tag projects with classifiers to refine searching and filtering\n* Search across all projects\n* Use REST API to programmatically interact with the system. Useful for\n integrating into a CI/CD system\n\n## Installation and Configuration\n\nSee the [documentation](https://django-sphinx-hosting.readthedocs.org) for how\nto install and configure `django-sphinx-hosting` in your Django project.\n",
"bugtrack_url": null,
"license": null,
"summary": "Reusable Django app for hosting Sphinx documentation privately.",
"version": "1.5.1",
"project_urls": {
"Documentation": "https://django-sphinx-hosting.readthedocs.io/en/latest/",
"Homepage": "https://github.com/caltechads/django-sphinx-hosting",
"Issues": "https://github.com/caltechads/django-sphinx-hosting/issues",
"Source": "https://github.com/caltechads/django-sphinx-hosting"
},
"split_keywords": [
"documentation",
" sphinx",
" django"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "80d0a443881115b8de8757c4fdc1b22d171088e51556155b32687c1baa11f569",
"md5": "4a0a11978904157d8102cef9cf7e50cd",
"sha256": "77f6de4e0b48036d3c8d63a2a30faa12d5d9c55c8166d9025d38256cf9155f77"
},
"downloads": -1,
"filename": "django_sphinx_hosting-1.5.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4a0a11978904157d8102cef9cf7e50cd",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.7",
"size": 124308,
"upload_time": "2024-07-16T22:54:24",
"upload_time_iso_8601": "2024-07-16T22:54:24.292257Z",
"url": "https://files.pythonhosted.org/packages/80/d0/a443881115b8de8757c4fdc1b22d171088e51556155b32687c1baa11f569/django_sphinx_hosting-1.5.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f60ad3f6f434b94a7dc0b98e3a3076feab036f97d855795fb0c908fcc5d4ed57",
"md5": "ff3410bab7f1e7e1ec156240083a040c",
"sha256": "25069c7f02def07f6e434057720076c0efbbbf4a6f308982f7a80588206b3330"
},
"downloads": -1,
"filename": "django-sphinx-hosting-1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "ff3410bab7f1e7e1ec156240083a040c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 104396,
"upload_time": "2024-07-16T22:54:25",
"upload_time_iso_8601": "2024-07-16T22:54:25.940206Z",
"url": "https://files.pythonhosted.org/packages/f6/0a/d3f6f434b94a7dc0b98e3a3076feab036f97d855795fb0c908fcc5d4ed57/django-sphinx-hosting-1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-16 22:54:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "caltechads",
"github_project": "django-sphinx-hosting",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "django-sphinx-hosting"
}
JSON
