~netlandish/django-wiki

65de0e6b887713c41b615869f2402dbaefd7ab30 — Benjamin Bach 6 years ago 209a5f8 + ea6136c
Merge pull request #916 from benjaoming/docs-updates

Docs updates for Django 2
2 files changed, 15 insertions(+), 9 deletions(-)

M docs/installation.rst
M docs/release_notes.rst
M docs/installation.rst => docs/installation.rst +12 -8
@@ 44,10 44,9 @@ To install the latest stable release::

    pip install wiki

Install directly from Github (in case you have no worries about
deploying our master branch directly)::
Install the latest pre-release (alpha, beta or rc)::

    pip install git+git://github.com/django-wiki/django-wiki.git
    pip install --pre wiki

Upgrading
---------


@@ 101,6 100,7 @@ to see the current default setting for this variable.
    TEMPLATES = [
        {
            'BACKEND': 'django.template.backends.django.DjangoTemplates',
            'APP_DIRS': True,
            # ...
            'OPTIONS': {
                'context_processors': [


@@ 155,14 155,18 @@ point to the root article:
Include urlpatterns
~~~~~~~~~~~~~~~~~~~

To integrate the wiki to your existing application, you should add the
following lines at the end of your project's ``urls.py``.
To integrate the wiki in your existing application, you should ensure the
following lines are included in your project's ``urls.py``.

.. code-block:: python

    urlpatterns += [
        url(r'^notifications/', include('django_nyt.urls')),
        url(r'', include('wiki.urls'))
    from django.contrib import admin
    from django.urls import path, include

    urlpatterns = [
        path('admin/', admin.site.urls),
        path('notifications/', include('django_nyt.urls')),
        path('', include('wiki.urls'))
    ]



M docs/release_notes.rst => docs/release_notes.rst +3 -1
@@ 49,7 49,9 @@ Fixed
 * Direct invocation of ``pytest`` fixed (removing ``runtests.py``) :url-issue:`781` (Branko Majic)
 * Line breaks in help texts for macros :url-issue:`851` (Mathias Dannesbo)
 * Table of contents now has a header by default, and several built-in django-wiki extensions can be configured using ``WIKI_MARKDOWN_KWARGS`` :url-issue:`881` (Mathias Rav)
 * S3 Storage engine image deletion bug :url-issue:`907` (Andrea Maschio)
 * S3 Storage engine image deletion bug :url-issue:`907` (Andrea Maschio & Benjamin Bach)
 * Back link on "permission denied" page should point to parent article on read errors (Benjamin Bach & Christian Duvholt)
 *

Deprecated/Removed
~~~~~~~~~~~~~~~~~~