Skip to content

Commit 0fa54bb

Browse files
author
Janneke Janssen
committed
Me like
1 parent f898fa9 commit 0fa54bb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+36
-596
lines changed

.DS_Store

6 KB
Binary file not shown.

README.rst

+11-28
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,34 @@
11
=====================================
2-
Django-documentation
2+
Django ProteQ Docs
33
=====================================
44

55
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>`_.
78

89

910
Installation
1011
============
1112

12-
Depedencies
13-
~~~~~~~~~~~
14-
15-
django-documentation depends on `Sphinx <http://sphinx.pocoo.org>`_
16-
17-
Installing django-documentation
13+
Installing django-proteq-docs
1814
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1915

2016
Install into your python path using pip::
2117

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
2419

25-
Add *'documentation'* to your INSTALLED_APPS in settings.py::
20+
Add *'proteq_docs'* to your INSTALLED_APPS in settings.py::
2621

2722
INSTALLED_APPS = (
2823
...
29-
'documentation',
24+
'proteq_docs',
3025
)
3126

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::
3328

3429
urlpatterns = patterns( '',
3530
....
36-
url(r'^docs/', include('documentation.urls', namespace='documentation'),
31+
url(r'^docs/', include('proteq_docs.urls', namespace='documentation'),
3732
)
3833

3934
Settings
@@ -47,21 +42,9 @@ staticfiles would be better suited for this task. ::
4742
DOCUMENTATION_ROOT = '/path/to/docs/'
4843
DOCUMENTATION_ACCESS_FUNCTION = lambda user: user.is_staff
4944

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
5746
is False, otherwise it uses
5847
`django.views.static.serve <https://docs.djangoproject.com/en/dev/howto/static-files/#django.views.static.serve>`_
5948
To override use ::
6049

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

example_documentation/docs/Makefile

-130
This file was deleted.
Binary file not shown.
Binary file not shown.

example_documentation/docs/_build/html/.buildinfo

-4
This file was deleted.

0 commit comments

Comments
 (0)