File tree 2 files changed +4
-2
lines changed
2 files changed +4
-2
lines changed Original file line number Diff line number Diff line change
1
+ include README.rst
Original file line number Diff line number Diff line change @@ -19,6 +19,7 @@ Installing django-simple-feedback
19
19
20
20
Install into your python path using pip::
21
21
22
+ pip install django-documentation
22
23
pip install -e git+git://github.com/Narsil/django-documentation.git#egg=django-documentation
23
24
24
25
Add *'documentation' * to your INSTALLED_APPS in settings.py::
@@ -39,14 +40,14 @@ Settings
39
40
~~~~~~~~
40
41
41
42
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
43
44
``lambda user: True ``, then you probably should not be using this app, as
44
45
staticfiles would be better suited for this task. ::
45
46
46
47
DOCUMENTATION_ROOT = '/path/to/docs/'
47
48
DOCUMENTATION_ACCESS_FUNCTION = lambda user: user.is_staff
48
49
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
50
51
placed somewhere else than ``DOCUMENTATION_ROOT + '_build/html/' `` then you
51
52
can override it with::
52
53
You can’t perform that action at this time.
0 commit comments