Skip to content

Commit 53c9c39

Browse files
Nicolas PatryNicolas Patry
Nicolas Patry
authored and
Nicolas Patry
committedSep 18, 2011
Updated the README.rst
1 parent d9fe08f commit 53c9c39

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed
 

‎MANIFEST.in

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
include README.rst

‎README.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Installing django-simple-feedback
1919

2020
Install into your python path using pip::
2121

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

2425
Add *'documentation'* to your INSTALLED_APPS in settings.py::
@@ -39,14 +40,14 @@ Settings
3940
~~~~~~~~
4041

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

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

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

0 commit comments

Comments
 (0)
Please sign in to comment.