1
1
=====================================
2
- Django-documentation
2
+ Django ProteQ Docs
3
3
=====================================
4
4
5
5
This `Django <http://djangoproject.com >`_ app has for purpose to integrate
6
- protected sphinx based documentation .
6
+ protected Sphinx based proteq_docs. Based on `django-documentation
7
+ <https://github.com/Narsil/django-documentation> `_.
7
8
8
9
9
10
Installation
10
11
============
11
12
12
- Depedencies
13
- ~~~~~~~~~~~
14
-
15
- django-documentation depends on `Sphinx <http://sphinx.pocoo.org >`_
16
-
17
- Installing django-documentation
13
+ Installing django-proteq-docs
18
14
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
19
15
20
16
Install into your python path using pip::
21
17
22
- pip install django-documentation
23
- pip install -e git+git://github.com/Narsil/django-documentation.git#egg=django-documentation
18
+ pip install -e git+http://github.com/jjanssen/django-proteq-docs.git#egg=django-proteq-docs
24
19
25
- Add *'documentation ' * to your INSTALLED_APPS in settings.py::
20
+ Add *'proteq_docs ' * to your INSTALLED_APPS in settings.py::
26
21
27
22
INSTALLED_APPS = (
28
23
...
29
- 'documentation ',
24
+ 'proteq_docs ',
30
25
)
31
26
32
- Add *'url(r'^docs/', include('documentation .urls', namespace='documentation')' * to your urls::
27
+ Add *'url(r'^docs/', include('proteq_docs .urls', namespace='documentation')' * to your urls::
33
28
34
29
urlpatterns = patterns( '',
35
30
....
36
- url(r'^docs/', include('documentation .urls', namespace='documentation'),
31
+ url(r'^docs/', include('proteq_docs .urls', namespace='documentation'),
37
32
)
38
33
39
34
Settings
@@ -47,21 +42,9 @@ staticfiles would be better suited for this task. ::
47
42
DOCUMENTATION_ROOT = '/path/to/docs/'
48
43
DOCUMENTATION_ACCESS_FUNCTION = lambda user: user.is_staff
49
44
50
- The DOCUMENATION_ROOT is the root of your sphinx doc where the Makefile exists, if you html docs is
51
- placed somewhere else than ``DOCUMENTATION_ROOT + '_build/html/' `` then you
52
- can override it with::
53
-
54
- DOCUMENTATION_HTML_ROOT = '/my/other/location/
55
-
56
- Note that django-documentation serves the content via x-sendfile when DEBUG
45
+ Note that django-proteq-docs serves the content via x-sendfile when DEBUG
57
46
is False, otherwise it uses
58
47
`django.views.static.serve <https://docs.djangoproject.com/en/dev/howto/static-files/#django.views.static.serve >`_
59
48
To override use ::
60
49
61
- DOCUMENTATION_XSENDFILE = True
62
-
63
- django-documentation also comes with a command goodies ::
64
-
65
- ./manage.py makedoc
66
-
67
- to generate the documentation.
50
+ DOCUMENTATION_XSENDFILE = True
0 commit comments