diff --git a/docs/conf.py b/docs/conf.py index 2c490d4..9270662 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -44,7 +44,7 @@ # General information about the project. project = "Django-CSP" -copyright = "2016-2024 Mozilla" +copyright = "2016-%Y Mozilla" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/docs/configuration.rst b/docs/configuration.rst index e412a52..836fd13 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -114,6 +114,11 @@ policy. number of CSP violation reports made to your ``report-uri``. A **float** between 0.0 and 100.0 (0.0 = no reports at all, 100.0 = always report). Ignored if ``report-uri`` isn't set. + .. note:: + To allow rate limiting, ``csp.contrib.rate_limiting.RateLimitedCSPMiddleware`` must be used + instead of ``csp.middleware.CSPMiddleware``. + See :ref:`violation reporting ` for more details. + ``DIRECTIVES`` A dictionary of policy directives. Each key in the dictionary is a directive and the value is a list of sources for that directive. The following is a list of all the directives that can be diff --git a/docs/index.rst b/docs/index.rst index 419ab76..0eff01b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,5 @@ -.. Django-CSP documentation master file, created by - sphinx-quickstart on Wed Oct 31 13:02:27 2012. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. Django-CSP documentation home. + It should contain at least the root `toctree` directive. ========== django-csp @@ -29,12 +27,4 @@ Contents: contributing -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - - .. _Content-Security-Policy: http://www.w3.org/TR/CSP/