Added first proposal docs.

This commit is contained in:
Martin Mahner 2009-07-10 21:28:46 +02:00
parent 64be785eb0
commit 93a547e504
3 changed files with 77 additions and 8 deletions

16
docs/configuration.txt Normal file
View file

@ -0,0 +1,16 @@
.. _configuration:
=============
Configuration
=============
To install django-authority just add the package to your ``INSTALLED_APPS``
setting within your ``settings.py``::
# settings.py
INSTALLED_APPS = (
...
'authority',
)
Thats all.

View file

@ -1,19 +1,27 @@
.. django-authority documentation master file, created by
============================================
Welcome to django-authority's documentation!
============================================
Please fill me.
A Django app for per-object-permissions, loosely based on
`django-granular-permissions`_.
.. _django-granular-permissions: http://code.google.com/p/django-granular-permissions/
.. toctree::
:maxdepth: 2
:numbered:
:glob:
installation
configuration
*
..
Indices and tables
==================
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. * :ref:`genindex`
.. * :ref:`modindex`
* :ref:`search`

45
docs/installation.txt Normal file
View file

@ -0,0 +1,45 @@
.. _installation:
============
Installation
============
The installation of django-authority is easy. Whether you want to use the
latest stable or development version, you have different options.
The latest stable version
=========================
The latest, stable version is always available via the `python package index_`
(pypi). You can download the latest version on `the site`_ but most users
would prefer either ``pip`` or ``easy_install``::
pip install django-authority
# .. or with easy_install:
easy_install django-authority
.. _the site: http://pypi.python.org/pypi/django-authority/
.. _python package index: http://pypi.python.org/pypi
Development version
===================
The latest development version is located on it's `bitbucket account`_. You
can checkout the package using the mercurial_ cvs::
hg clone https://barttc@bitbucket.org/jezdez/django-authority/
Then install it manually::
cd django-authority
python setup.py install
.. warning:: The development version is not fully tested and may contain
bugs, so we prefer to use the latest package from pypi.
.. _bitbucket account: http://bitbucket.org/jezdez/django-authority/
.. _mercurial: http://www.selenic.com/mercurial/
See :configuration: for the next step.