IATI Sphinx Theme

Installation

1. Install the theme in your Sphinx project.

   pip install iati-sphinx-theme
   

2. In your project’s conf.py set the html_theme.

   html_theme = "iati_sphinx_theme"
   

Configuration

This theme has multiple options, which can be configured using the html_theme_options object in your conf.py file.

html_theme_options = {
  "github_repository": "https://github.com/organisation/repository",
  "plausible_domain": "example.com"
}

There is more information on each option below.

github_repository

This should be a link to the Github repository for the documentation site, and is used to link to the source code in the footer of the site.

plausible_domain

To integrate with Plausible Analytics, add the plausible_domain option in your project’s conf.py file.

If your docs site is a subdomain for the site it is documenting, use the top level domain for cross-subdomain tracking. For example, for the Sphinx site docs.example.com, use example.com as your plausible_domain.

html_theme_options = {
  "plausible_domain": "example.com"
}