| Name | django-sphinx-hosting JSON |
| Version |
1.6.1
JSON |
| download |
| home_page | None |
| Summary | Reusable Django app for hosting Sphinx documentation privately. |
| upload_time | 2024-12-18 22:58:47 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
documentation
sphinx
django
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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": null,
"name": "django-sphinx-hosting",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "Chris Malek <cmalek@caltech.edu>",
"keywords": "documentation, sphinx, django",
"author": null,
"author_email": "Caltech IMSS ADS <imss-ads-staff@caltech.edu>",
"download_url": "https://files.pythonhosted.org/packages/38/5e/b9d02fdc7c534184615daef041b0e3b6bc4e17e1767ed1eabe72fbf66896/django_sphinx_hosting-1.6.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.6.1",
"project_urls": {
"Documentation": "https://django-sphinx-hosting.readthedocs.io/en/latest/",
"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": "154c92366ef21a24933b0e5a239e056a981fb0099593404a186be11bb2751d43",
"md5": "e82beb4b9d17fbcadb4298ae4245826d",
"sha256": "11ef50fecf6abed100410c6be60e0d78d043e02e79031acda7785a53b4a6f2d8"
},
"downloads": -1,
"filename": "django_sphinx_hosting-1.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e82beb4b9d17fbcadb4298ae4245826d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 152770,
"upload_time": "2024-12-18T22:58:44",
"upload_time_iso_8601": "2024-12-18T22:58:44.931264Z",
"url": "https://files.pythonhosted.org/packages/15/4c/92366ef21a24933b0e5a239e056a981fb0099593404a186be11bb2751d43/django_sphinx_hosting-1.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "385eb9d02fdc7c534184615daef041b0e3b6bc4e17e1767ed1eabe72fbf66896",
"md5": "ba0e9391f10ca42535d3b6a9ce4114b3",
"sha256": "b156af07403ba4be3342651b86965b479632bd7dc9fc7d3522de126aa41c9d8f"
},
"downloads": -1,
"filename": "django_sphinx_hosting-1.6.1.tar.gz",
"has_sig": false,
"md5_digest": "ba0e9391f10ca42535d3b6a9ce4114b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 124898,
"upload_time": "2024-12-18T22:58:47",
"upload_time_iso_8601": "2024-12-18T22:58:47.454067Z",
"url": "https://files.pythonhosted.org/packages/38/5e/b9d02fdc7c534184615daef041b0e3b6bc4e17e1767ed1eabe72fbf66896/django_sphinx_hosting-1.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 22:58:47",
"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"
}
