From 13ffd5db403af7e3da8276dc4c21c0f47586722e Mon Sep 17 00:00:00 2001 From: medmunds Date: Sat, 18 Aug 2018 17:36:10 -0700 Subject: [PATCH] Docs: add Rate-the-Docs --- docs/_static/anymail-config.js | 4 ++++ docs/conf.py | 2 ++ docs/docs_privacy.rst | 9 +++++++-- 3 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 docs/_static/anymail-config.js diff --git a/docs/_static/anymail-config.js b/docs/_static/anymail-config.js new file mode 100644 index 0000000..7dd31a9 --- /dev/null +++ b/docs/_static/anymail-config.js @@ -0,0 +1,4 @@ +window.RATETHEDOCS_OPTIONS = { + contactLink: "/help/#contact", + privacyLink: "/docs_privacy/" +}; diff --git a/docs/conf.py b/docs/conf.py index c4ca1f8..2142bc0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -278,7 +278,9 @@ intersphinx_mapping = { def setup(app): app.add_stylesheet("anymail-theme.css") + app.add_javascript("anymail-config.js") app.add_javascript("version-alert.js") + app.add_javascript("https://unpkg.com/rate-the-docs") # Django-specific roles, from https://github.com/django/django/blob/master/docs/_ext/djangodocs.py: app.add_crossref_type( diff --git a/docs/docs_privacy.rst b/docs/docs_privacy.rst index a3f7f24..f9041f0 100644 --- a/docs/docs_privacy.rst +++ b/docs/docs_privacy.rst @@ -20,6 +20,11 @@ behavior. Anymail's maintainers *do not* collect or have access to any personally identifiable (or even *potentially* personally identifiable) information about visitors to this documentation site. +We also use Google Analytics to collect feedback from the "Is this page helpful?" +box at the bottom of the page. Please do not include any personally-identifiable +information in suggestions you submit through this form. +(If you would like to contact Anymail's maintainers, see :ref:`contact`.) + Anymail's maintainers have *not* connected our Google Analytics implementation to any Google Advertising Services. (Incidentally, we're not involved with the ads you may see here. Those come from---and support---Read the Docs under @@ -32,9 +37,9 @@ analytics tracking, see the "Information for Visitors of Sites and Apps Using Google Analytics" section of Google's `Safeguarding your data`_ document. Questions about privacy and information practices related to this Anymail -documentation site can be emailed to "privacy\anymail\info". +documentation site can be emailed to *privacy\anymail\info*. (This is not an appropriate contact for questions about *using* Anymail; -see :ref:`troubleshooting` if you need assistance with your code.) +see :ref:`help` if you need assistance with your code.) .. _anymail.readthedocs.io: