This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description
=====================================
Django-documentation
=====================================

This `Django <http: djangoproject.com="">`_ app has for purpose to integrate
protected sphinx based documentation .


Installation
============

Depedencies
~~~~~~~~~~~

django-documentation depends on `Sphinx <http: sphinx.pocoo.org="">`_

Installing django-simple-feedback
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Install into your python path using pip::

pip install django-documentation
pip install -e git+git://github.com/Narsil/django-documentation.git#egg=django-documentation

Add *'documentation'* to your INSTALLED_APPS in settings.py::

INSTALLED_APPS = (
...
'documentation',
)

Add *'(r'^docs/', include('documentation.urls')'* to your urls::

urlpatterns = patterns( '',
....
(r'^docs/', include('documentation.urls'),
)

Settings
~~~~~~~~

Set up where is your documentation, and a function that has a user for argument
and returns **True** if user is allowed to see the doc. If you plan on using
``lambda user: True``, then you probably should not be using this app, as
staticfiles would be better suited for this task. ::

DOCUMENTATION_ROOT = '/path/to/docs/'
DOCUMENTATION_ACCESS_FUNCTION = lambda user: user.is_staff

The DOCUMENATION_ROOT is the root of your sphinx doc where the Makefile exists, if you html docs is
placed somewhere else than ``DOCUMENTATION_ROOT + '_build/html/'`` then you
can override it with::

DOCUMENTATION_HTML_ROOT = '/my/other/location/

Note that django-documentation serves the content via x-sendfile when DEBUG
is False, otherwise it uses
`django.views.static.serve <https: docs.djangoproject.com="" en="" dev="" howto="" static-files="" #django.views.static.serve="">`_
To override use ::

DOCUMENTATION_XSENDFILE = True

django-documentation also comes with a command goodies ::

./manage.py makedoc

to generate the documentation.
Release History

Release History

1.1

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

1.0

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
django-documentation-1.1.tar.gz (6.1 kB) Copy SHA256 Checksum SHA256 Source Jan 3, 2014

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting