-
+
- 
-
-
-
-
-
- Get Pro Support
- This project is commercially supported by CodeRed.
-
-
- Get Pro Support
- This project is commercially supported by CodeRed.
-
diff --git a/docs/conf.py b/docs/conf.py
index f47a56f..bed38de 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,20 +1,22 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain a selection of the most common options. For a
-# full list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+"""
+Configuration file for the Sphinx documentation builder.
+This file does only contain a selection of the most common options. For a
+full list see the documentation:
+http://www.sphinx-doc.org/en/master/config
+
+-- Path setup --------------------------------------------------------------
+
+If extensions (or modules to document with autodoc) are in another directory,
+add these directories to sys.path here. If the directory is relative to the
+documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('.'))
+"""
import datetime
+
from wagtailcache import __shortversion__
@@ -23,15 +25,11 @@
project = "wagtail-cache"
author = "CodeRed LLC"
copyright = f"2018–{str(datetime.datetime.now().year)}, {author}"
-
# The short X.Y version
version = __shortversion__
# The full version, including alpha/beta/rc tags
release = __shortversion__
-
-
# -- General configuration ---------------------------------------------------
-
source_suffix = ".rst"
master_doc = "index"
@@ -39,15 +37,11 @@
language = "en"
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
extensions = ["sphinx_wagtail_theme"]
-
-
# -- Options for HTML output -------------------------------------------------
-
html_show_sourcelink = False
html_theme = "sphinx_wagtail_theme"
diff --git a/docs/contributing.rst b/docs/contributing.rst
index 10b841f..15b36e4 100644
--- a/docs/contributing.rst
+++ b/docs/contributing.rst
@@ -29,10 +29,12 @@ development tools:
Write some code.
-Next, run the static analysis tools (``flake8`` and ``mypy``)
+Next, run the formatters and static analysis tools:
.. code-block:: console
+ $ isort .
+ $ black .
$ flake8 ./wagtailcache/
$ mypy ./wagtailcache/
diff --git a/docs/getting_started/hooks.rst b/docs/getting_started/hooks.rst
index c4199e6..1d01566 100644
--- a/docs/getting_started/hooks.rst
+++ b/docs/getting_started/hooks.rst
@@ -27,7 +27,7 @@ For example:
.. code-block:: python
- from wagtail.core import hooks
+ from wagtail import hooks
@hooks.register("is_request_cacheable")
def nocache_in_query(request, curr_cache_decision):
@@ -54,7 +54,7 @@ For example:
.. code-block:: python
- from wagtail.core import hooks
+ from wagtail import hooks
@hooks.register("is_response_cacheable")
def nocache_secrets(response, curr_cache_decision):
diff --git a/docs/getting_started/install.rst b/docs/getting_started/install.rst
index 2c892ae..77b80b6 100644
--- a/docs/getting_started/install.rst
+++ b/docs/getting_started/install.rst
@@ -40,7 +40,7 @@ adding the Wagtail Cache middleware.
2. Define a cache
-----------------
-Next a cache must be configured in the settings. If you use django-redis, see :doc:`Supported Cache Backends `. Here is an example file cache,
+Next a cache must be configured in the settings. Here is an example file cache,
which is suitable for use on any web server:
.. code-block:: python
@@ -200,11 +200,11 @@ To this:
from django.conf.urls import url
from django.contrib.auth import views as auth_views
- from wagtail.core.urls import serve_pattern, WAGTAIL_FRONTEND_LOGIN_TEMPLATE
- from wagtail.core import views as wagtail_views
+ from wagtail.urls import serve_pattern, WAGTAIL_FRONTEND_LOGIN_TEMPLATE
+ from wagtail import views as wagtail_views
from wagtailcache.cache import cache_page
- # Copied from wagtail.core.urls:
+ # Copied from wagtail.urls:
url(r'^_util/authenticate_with_password/(\d+)/(\d+)/$', wagtail_views.authenticate_with_password,
name='wagtailcore_authenticate_with_password'),
url(r'^_util/login/$', auth_views.LoginView.as_view(template_name=WAGTAIL_FRONTEND_LOGIN_TEMPLATE),
diff --git a/docs/getting_started/supported_backends.rst b/docs/getting_started/supported_backends.rst
index acabaa3..5058e95 100644
--- a/docs/getting_started/supported_backends.rst
+++ b/docs/getting_started/supported_backends.rst
@@ -16,19 +16,6 @@ Built-in Django cache backends
Wagtail Cache may or may not work correctly with 3rd party backends. If you experience an issue, please
`report it on our GitHub page