Enable Google Analytics¶

Many documentation sites collect page view and user behavior data with Google Analytics. Collecting this data requires the user’s consent.

Once you’re through with the guide, analytics will be collected on all public versions of your documentation.

Add or update templates¶

The header template inserts the Google Analytics tracking tag onto each page. If a user consents to being tracked, their traffic and search data will be collected with each page interaction.

The footer template provides a link for users to change their data collection preferences.

The process for sourcing these files depends on your Starter Pack version. Check which version is listed in your project’s docs/.sphinx/version file.

On Starter Pack 1.6 or higher¶

Starting in version 1.6 of the Starter Pack, these templates are available by default. If you’re on one of these versions, skip ahead to Update your configuration file.

On Starter Pack 1.5 or lower¶

In version 1.5 of the Starter Pack and lower, the templates were sourced from a separate repository.

Download the latest version of the templates:

Next, create a docs/_templates directory and move the templates into it.

If you find that your project already has a header.html file, add the following HTML immediately after the opening <header> tag:

<!-- Google Tag Manager -->
<script>
(function(w, d, s, l, i) {
  w[l] = w[l] || [];
  w[l].push({
    'gtm.start': new Date().getTime(),
    event: 'gtm.js'
  });
  var f = d.getElementsByTagName(s)[0],
    j = d.createElement(s),
    dl = l != 'dataLayer' ? '&l=' + l : '';
  j.async = true;
  j.src =
    'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
  f.parentNode.insertBefore(j, f);
})(window, document, 'script', 'dataLayer', 'GTM-KNX3CJC');
</script>

Similarly, if your project already has a footer.html file, add the following highlighted line to the right-details div:

<div class="right-details">
  <a href="" class="js-revoke-cookie-manager muted-link">Manage your tracker settings</a>
</div>

Update your configuration file¶

Now that the templates are in place, you need to make Sphinx aware of them in your project’s configuration file.

If you’re on version 1.6 of the Starter Pack or higher, these lines already exist in your configuration file. You only need to uncomment them in the following steps. In lower versions, you need to add them yourself.

Add or uncomment the following line:

conf.py¶

templates_path = ["_templates"]

The script and style sheet for the cookie banner are hosted remotely. Include them in your docs by adding or uncommenting the following lines in the conf.py file: