{ "info": { "author": "Chris Davies", "author_email": "christopherdavies553@gmail.com", "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\n* Django 1.8 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", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/chris104957/django-docs", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "django-2-docs", "package_url": "https://pypi.org/project/django-2-docs/", "platform": "", "project_url": "https://pypi.org/project/django-2-docs/", "project_urls": { "Homepage": "https://github.com/chris104957/django-docs" }, "release_url": "https://pypi.org/project/django-2-docs/0.2.2/", "requires_dist": null, "requires_python": "", "summary": "Allows to serve Sphinx generated docs from django.", "version": "0.2.2" }, "last_serial": 3909195, "releases": { "0.2.1": [ { "comment_text": "", "digests": { "md5": "d7d844bbb81f39d3f789fef743464b16", "sha256": "aa4e2b4ddddfec7a3a8dbc90ef859606b558f6159a7fe2f5eee425b97e135685" }, "downloads": -1, "filename": "django-2-docs-0.2.1.tar.gz", "has_sig": false, "md5_digest": "d7d844bbb81f39d3f789fef743464b16", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6619, "upload_time": "2018-05-29T10:00:04", "url": "https://files.pythonhosted.org/packages/22/4e/0662bb2e18716f18e64413def084c189f3184471edaa06a54bbf9d962548/django-2-docs-0.2.1.tar.gz" } ], "0.2.2": [ { "comment_text": "", "digests": { "md5": "a26d6fa636bfbedc0a26d71f29dd0c3f", "sha256": "6589863922709303dbe9b65c3c60b559188844ad16730c64d70d049154defc39" }, "downloads": -1, "filename": "django-2-docs-0.2.2.tar.gz", "has_sig": false, "md5_digest": "a26d6fa636bfbedc0a26d71f29dd0c3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6624, "upload_time": "2018-05-29T13:44:34", "url": "https://files.pythonhosted.org/packages/bd/ff/36a9837f5bd84fd714b039c4eb780a322cdf2b2e977cc2c910c593c9d426/django-2-docs-0.2.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a26d6fa636bfbedc0a26d71f29dd0c3f", "sha256": "6589863922709303dbe9b65c3c60b559188844ad16730c64d70d049154defc39" }, "downloads": -1, "filename": "django-2-docs-0.2.2.tar.gz", "has_sig": false, "md5_digest": "a26d6fa636bfbedc0a26d71f29dd0c3f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6624, "upload_time": "2018-05-29T13:44:34", "url": "https://files.pythonhosted.org/packages/bd/ff/36a9837f5bd84fd714b039c4eb780a322cdf2b2e977cc2c910c593c9d426/django-2-docs-0.2.2.tar.gz" } ] }