{ "info": { "author": "Evgeny Demchenko", "author_email": "little_pea@list.ru", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Framework :: Django", "Intended Audience :: Developers", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "django-docs\n===========\n\n.. image:: https://img.shields.io/travis/littlepea/django-docs.svg?style=flat-square\n :target: http://travis-ci.org/littlepea/django-docs\n\n.. image:: https://img.shields.io/pypi/v/django-docs.svg?style=flat-square\n :target: https://pypi.python.org/pypi/django-docs/\n\n.. image:: https://img.shields.io/badge/license-New%20BSD-blue.svg?style=flat-square\n :target: https://raw.githubusercontent.com/littlepea/django-docs/master/LICENSE\n\n`django-docs` allows to serve Sphinx generated docs directly from Django.\n\nDependencies\n------------\n\n* Python 2.7-3.6 for Django 1.8 - 1.11\n* Python 3.4-3.6 for Django 2.0 or higher\n\nCredits\n-------\n\n* Project on GitHub: `littlepea/django-docs `_\n* `Documentation on Read The Docs `_\n* Maintained by `Evgeny Demchenko `_\n\nInstallation\n------------\n\n1. Install `django-docs` package::\n\n pip install django-docs\n\n2. Add `docs` to INSTALLED_APPS in settings.py::\n\n INSTALLED_APPS = (\n ...\n 'docs',\n ...\n )\n\n3. Add `docs.urls` to urls.py::\n\n urlpatterns = [\n ...\n url(r'^docs/', include('docs.urls')),\n ...\n ]\n\n4. Customize configuration::\n\n DOCS_ROOT = os.path.join(PROJECT_PATH, '../docs/_build/html')\n DOCS_ACCESS = 'staff'\n\nConfiguration\n-------------\n\nDOCS_ROOT (required)\n^^^^^^^^^^^^^^^^^^^^\n\nAbsolute path to the root directory of html docs generated by Sphinx (just like STATIC_ROOT / MEDIA_ROOT settings).\n\nDOCS_ACCESS (optional)\n^^^^^^^^^^^^^^^^^^^^^^\n\nDocs access level (public by default). Possible values:\n\n* public - (default) docs are visible to everyone\n* login_required - docs are visible only to authenticated users\n* staff - docs are visible only to staff users (user.is_staff == True)\n* superuser - docs are visible only to superusers (user.is_superuser == True)\n\nRunning the tests\n-----------------\n\nMake sure to install `test_requirements.txt` first::\n\n pip install -r test_requirements.txt\n pip install -e .\n\nYou can run the tests with via::\n\n python setup.py test\n\nor::\n\n python docs/tests/runtests.py\n\nTo run all tests against different versions of Django simply run::\n\n tox\n\nRunning the example project\n---------------------------\n\nMake sure to install `requirements.txt` first::\n\n virtualenv env\n . env/bin/activate\n pip install -r test_requirements.txt\n pip install -e .\n\nYou can run the example project with via::\n\n cd example\n python manage.py migrate\n python manage.py runserver\n\nScreenshot\n----------\n\n.. image:: https://www.evernote.com/l/AHRVMNRZKLVPaoCgJouF_-Pz7rfeDzGF32sB/image.png\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/littlepea/django-docs", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "django-docs", "package_url": "https://pypi.org/project/django-docs/", "platform": "", "project_url": "https://pypi.org/project/django-docs/", "project_urls": { "Homepage": "https://github.com/littlepea/django-docs" }, "release_url": "https://pypi.org/project/django-docs/0.3.1/", "requires_dist": [ "Django (>=1.11)" ], "requires_python": "", "summary": "Allows to serve Sphinx generated docs from django.", "version": "0.3.1" }, "last_serial": 4503227, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "cbe9d370db0a28619e7ad859ef7641a7", "sha256": "cef2f756c8e822e2963fbd00eb439f2fbf9e47dfa6cd2d9e1cb07f32316cbfa9" }, "downloads": -1, "filename": "django_docs-0.1.0-py2.7.egg", "has_sig": false, "md5_digest": "cbe9d370db0a28619e7ad859ef7641a7", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 19552, "upload_time": "2013-04-29T13:36:37", "url": "https://files.pythonhosted.org/packages/c1/27/03e31829bb541a60c665d38e77ca9632b6409bc4c949dbffe06da844f271/django_docs-0.1.0-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "ee6a5f4f4e667f47ad2611502740141e", "sha256": "e9d296ef5053b319665299fa308c27d7d7233251cb6a34caff77baa32bfb4256" }, "downloads": -1, "filename": "django-docs-0.1.0.tar.gz", "has_sig": false, "md5_digest": "ee6a5f4f4e667f47ad2611502740141e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8576, "upload_time": "2013-04-29T13:36:34", "url": "https://files.pythonhosted.org/packages/88/02/77ec51361302cf58b2386c967649b8942a2ca4ea525cb61340dbd1f8dd84/django-docs-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "5681612cd9af2201b13bad67fdd74112", "sha256": "5579633c9027e6f108b4f4bf26c7d06b7ab77c6fcb2d64068122e8dbd1f1c8fe" }, "downloads": -1, "filename": "django_docs-0.1.1-py2.7.egg", "has_sig": false, "md5_digest": "5681612cd9af2201b13bad67fdd74112", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 20087, "upload_time": "2013-04-30T08:58:50", "url": "https://files.pythonhosted.org/packages/66/0b/ee9cb6a3d6b28fcf202270bfefe026a954af895a1a085b2aabbba5fe03d7/django_docs-0.1.1-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "24937d57f856fe4fccc94ec7a53528cf", "sha256": "12eac78c1b928faf356e032f93c6757ea697912c1a95871c7ec78b704b6d5755" }, "downloads": -1, "filename": "django-docs-0.1.1.tar.gz", "has_sig": false, "md5_digest": "24937d57f856fe4fccc94ec7a53528cf", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9151, "upload_time": "2013-04-30T08:58:47", "url": "https://files.pythonhosted.org/packages/e7/1d/dbbfd2c006b143556ef885438282d551a1314818009ac99fa2c412b9ae53/django-docs-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "1825602a6019d449c914fe28cf85d447", "sha256": "8c76405b0eb8b1e4968055aef19fb0be5ffef204bdc4a9767a90775b92c09d2a" }, "downloads": -1, "filename": "django_docs-0.1.2-py2.7.egg", "has_sig": false, "md5_digest": "1825602a6019d449c914fe28cf85d447", "packagetype": "bdist_egg", "python_version": "2.7", "requires_python": null, "size": 20152, "upload_time": "2013-04-30T10:44:02", "url": "https://files.pythonhosted.org/packages/1a/0a/0f876f8023f0e3ec5d7108f4a0adeb694e36b6eebc86b67880e5406a7f1c/django_docs-0.1.2-py2.7.egg" }, { "comment_text": "", "digests": { "md5": "a2de61496883cf478576ba13527bc767", "sha256": "e0a416253e0ac60c3d8f3d823e4da1d93df2fa9efbe54cb11e2829df71dffec2" }, "downloads": -1, "filename": "django-docs-0.1.2.tar.gz", "has_sig": false, "md5_digest": "a2de61496883cf478576ba13527bc767", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9224, "upload_time": "2013-04-30T10:43:58", "url": "https://files.pythonhosted.org/packages/ee/e0/8e988718e8a9eb8304c0ac1078e784032404604633d3c565a0a4ddb60837/django-docs-0.1.2.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "54e9e765d64bde6acd3960cdbef2a4ed", "sha256": "92e0834a5905558377608593cf9560de6b8d663e842696cc8c04a51653ef2e18" }, "downloads": -1, "filename": "django-docs-0.2.tar.gz", "has_sig": false, "md5_digest": "54e9e765d64bde6acd3960cdbef2a4ed", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6437, "upload_time": "2016-08-18T06:28:23", "url": "https://files.pythonhosted.org/packages/b9/2f/9baf4fbd88a31ab1d9b86af9dc08094a5357288844ba4a57f2f3ad3b3fb7/django-docs-0.2.tar.gz" } ], "0.2.1": [ { "comment_text": "", "digests": { "md5": "48d9e0f1d0600725f965abdd0f9af4ab", "sha256": "75d875de511be62f8e85f5bd952498b65a9baf1fa912cf6c8e5163b3af1dcc7d" }, "downloads": -1, "filename": "django-docs-0.2.1.tar.gz", "has_sig": false, "md5_digest": "48d9e0f1d0600725f965abdd0f9af4ab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6571, "upload_time": "2016-09-21T02:31:05", "url": "https://files.pythonhosted.org/packages/9b/cc/f8f2ff26217e97974f79ac188dbd75e7b194aba64244b9c44d60e38c8c05/django-docs-0.2.1.tar.gz" } ], "0.3.0": [ { "comment_text": "", "digests": { "md5": "518640f09f1f256f2fe22f8e11d6ba77", "sha256": "59e53fbbdda4ad851698b1bf30e6b87a96de5cb2a160bc2b42d14a5b8bb8abaf" }, "downloads": -1, "filename": "django_docs-0.3.0-py3-none-any.whl", "has_sig": false, "md5_digest": "518640f09f1f256f2fe22f8e11d6ba77", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8900, "upload_time": "2018-06-16T10:17:35", "url": "https://files.pythonhosted.org/packages/23/75/32a541c83822cf3e6fcdee05254acc7d275bbfc02769b20930828798efaa/django_docs-0.3.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "6a08fc917d759f25740f62d647f0a219", "sha256": "a3c2ea53a31127616e035b7bf7e369050dc506a698fdc59dcac79c9b7dd3adff" }, "downloads": -1, "filename": "django-docs-0.3.0.tar.gz", "has_sig": false, "md5_digest": "6a08fc917d759f25740f62d647f0a219", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6699, "upload_time": "2018-06-16T10:17:36", "url": "https://files.pythonhosted.org/packages/11/70/9dfad0bb884b673e1eed9daab4048e956724ccb544b9768f06688747e8bc/django-docs-0.3.0.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "266b4ae4a5d26968e564894598985177", "sha256": "b233e0b30e2ad417787f0276c3750c90ed9d00cbb3bec1b63f10028c06e5bcdc" }, "downloads": -1, "filename": "django_docs-0.3.1-py3-none-any.whl", "has_sig": false, "md5_digest": "266b4ae4a5d26968e564894598985177", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8888, "upload_time": "2018-11-19T15:04:23", "url": "https://files.pythonhosted.org/packages/60/a3/e5911935c9476850d9c828cdcd5f36c3e3c4b09f6ed087d361e0dfdda238/django_docs-0.3.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3564ac19cd6dbf3b3532782397a133b7", "sha256": "5d2a240b1208a41a6c4d1bf6a4350260b34b2f274df2e27d5c4481e0a66d3bef" }, "downloads": -1, "filename": "django-docs-0.3.1.tar.gz", "has_sig": false, "md5_digest": "3564ac19cd6dbf3b3532782397a133b7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6687, "upload_time": "2018-11-19T15:04:24", "url": "https://files.pythonhosted.org/packages/1f/48/03d0b50ae2650d750f21c7d6a438239fd8ca3cbac6506c923d20c76c1d75/django-docs-0.3.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "266b4ae4a5d26968e564894598985177", "sha256": "b233e0b30e2ad417787f0276c3750c90ed9d00cbb3bec1b63f10028c06e5bcdc" }, "downloads": -1, "filename": "django_docs-0.3.1-py3-none-any.whl", "has_sig": false, "md5_digest": "266b4ae4a5d26968e564894598985177", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8888, "upload_time": "2018-11-19T15:04:23", "url": "https://files.pythonhosted.org/packages/60/a3/e5911935c9476850d9c828cdcd5f36c3e3c4b09f6ed087d361e0dfdda238/django_docs-0.3.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3564ac19cd6dbf3b3532782397a133b7", "sha256": "5d2a240b1208a41a6c4d1bf6a4350260b34b2f274df2e27d5c4481e0a66d3bef" }, "downloads": -1, "filename": "django-docs-0.3.1.tar.gz", "has_sig": false, "md5_digest": "3564ac19cd6dbf3b3532782397a133b7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6687, "upload_time": "2018-11-19T15:04:24", "url": "https://files.pythonhosted.org/packages/1f/48/03d0b50ae2650d750f21c7d6a438239fd8ca3cbac6506c923d20c76c1d75/django-docs-0.3.1.tar.gz" } ] }