{ "info": { "author": "Nicolas Patry", "author_email": "nicolas@kwyk.fr", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Internet", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "=====================================\nDjango-documentation\n=====================================\n\nThis `Django `_ app has for purpose to integrate\nprotected sphinx based documentation .\n\n\nInstallation \n============\n\nDepedencies \n~~~~~~~~~~~\n\ndjango-documentation depends on `Sphinx `_\n\nInstalling django-simple-feedback\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nInstall into your python path using pip::\n\n pip install django-documentation\n pip install -e git+git://github.com/Narsil/django-documentation.git#egg=django-documentation\n\nAdd *'documentation'* to your INSTALLED_APPS in settings.py::\n\n INSTALLED_APPS = (\n ...\n 'documentation',\n )\n\nAdd *'(r'^docs/', include('documentation.urls')'* to your urls:: \n\n urlpatterns = patterns( '',\n ....\n (r'^docs/', include('documentation.urls'),\n )\n\nSettings\n~~~~~~~~\n\nSet up where is your documentation, and a function that has a user for argument\nand returns **True** if user is allowed to see the doc. If you plan on using \n``lambda user: True``, then you probably should not be using this app, as\nstaticfiles would be better suited for this task. ::\n\n DOCUMENTATION_ROOT = '/path/to/docs/'\n DOCUMENTATION_ACCESS_FUNCTION = lambda user: user.is_staff\n\nThe DOCUMENATION_ROOT is the root of your sphinx doc where the Makefile exists, if you html docs is \nplaced somewhere else than ``DOCUMENTATION_ROOT + '_build/html/'`` then you\ncan override it with::\n\n DOCUMENTATION_HTML_ROOT = '/my/other/location/\n\nNote that django-documentation serves the content via x-sendfile when DEBUG\nis False, otherwise it uses \n`django.views.static.serve `_\nTo override use ::\n\n DOCUMENTATION_XSENDFILE = True\n\ndjango-documentation also comes with a command goodies ::\n\n ./manage.py makedoc\n \nto generate the documentation.", "description_content_type": null, "docs_url": null, "download_url": "http://github.com/Narsil/django-documentation", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/Narsil/django-documentation", "keywords": "django documentation sphinx authentification", "license": "UNKNOWN", "maintainer": null, "maintainer_email": null, "name": "django-documentation", "package_url": "https://pypi.org/project/django-documentation/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/django-documentation/", "project_urls": { "Download": "http://github.com/Narsil/django-documentation", "Homepage": "http://github.com/Narsil/django-documentation" }, "release_url": "https://pypi.org/project/django-documentation/1.1/", "requires_dist": null, "requires_python": null, "summary": "Provides a way to integrate a protected sphinx based\n documentation within your django app.", "version": "1.1" }, "last_serial": 959556, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "f0de69c5e7847bea53289c14af181881", "sha256": "6a85e4de2120b27c0fb77a6a4181a3b5cecfc2803746712374aae6cff04dd1ae" }, "downloads": -1, "filename": "django-documentation-1.0.tar.gz", "has_sig": false, "md5_digest": "f0de69c5e7847bea53289c14af181881", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6170, "upload_time": "2011-09-19T00:03:45", "url": "https://files.pythonhosted.org/packages/bc/1d/fc36d4e3f6061ab381e4c3d2eab6e887becc2729fb9eaa5204437f965801/django-documentation-1.0.tar.gz" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "55f15c4a34b8c246b3709383298a15a4", "sha256": "4da3ddf19ce5f987fd483a1d7277c09faf02686d5a73c6f16c910f9df8e23624" }, "downloads": -1, "filename": "django-documentation-1.1.tar.gz", "has_sig": false, "md5_digest": "55f15c4a34b8c246b3709383298a15a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6057, "upload_time": "2014-01-03T13:40:19", "url": "https://files.pythonhosted.org/packages/62/e2/490b52d6751538017edf7bfa8fd13edf37f0ac01a8a348654a3b0dcc2e78/django-documentation-1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "55f15c4a34b8c246b3709383298a15a4", "sha256": "4da3ddf19ce5f987fd483a1d7277c09faf02686d5a73c6f16c910f9df8e23624" }, "downloads": -1, "filename": "django-documentation-1.1.tar.gz", "has_sig": false, "md5_digest": "55f15c4a34b8c246b3709383298a15a4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6057, "upload_time": "2014-01-03T13:40:19", "url": "https://files.pythonhosted.org/packages/62/e2/490b52d6751538017edf7bfa8fd13edf37f0ac01a8a348654a3b0dcc2e78/django-documentation-1.1.tar.gz" } ] }