diff --git a/docs/conf.py b/docs/conf.py index 96248c9f..44bab2de 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -48,6 +48,23 @@ html_theme = "furo" html_static_path = ["_static"] html_css_files = ["css/table.css"] +# Embedded SVG as recommended in Furo template. +# See https://pradyunsg.me/furo/customisation/footer/#using-embedded-svgs +with open("github.svg") as fh: + GITHUB_ICON_SVG = fh.read().strip() +html_theme_options = { + "source_repository": "https://github.com/theochem/iodata", + "source_branch": "main", + "source_directory": "docs/", + "footer_icons": [ + { + "name": "GitHub", + "url": "https://github.com/theochem/iodata", + "html": GITHUB_ICON_SVG, + "class": "", + }, + ], +} # -- Configuration for autodoc extensions --------------------------------- diff --git a/docs/github.svg b/docs/github.svg new file mode 100644 index 00000000..f5115c76 --- /dev/null +++ b/docs/github.svg @@ -0,0 +1,3 @@ + + +