Skip to main content
Ctrl+K
⚠️This is an experimental release sphinx-syft-theme ⚠️

Syft Theme

  • Documentation
  • About
  • Contributing
  • Tutorial
  • Syft Theme
  • Twitter
  • GitHub
  • Slack
  • Join on slack for #support
  • Documentation
  • About
  • Contributing
  • Tutorial
  • Syft Theme
  • Twitter
  • GitHub
  • Slack
  • Join on slack for #support

Section Navigation

  • About the Sphinx Syft Theme
  • Standalone Pages
  • Change Log

Tutorials

  • Get started
  • Notebook Demo Template

Components

  • Add your own CSS rules
  • Add a download page button
  • Icon links and badges
  • Logo and branding
  • Buttons that link to source files
  • Persona in Syft Theme

Sections

  • Announcement banners
  • Content footer
  • Page footer
  • Header and navbar
  • Secondary sidebar and table of contents

Contribute

  • Set up your development workflow
  • Style and design
  • Creating sub-themes
  • Testing infrastructure
  • Translation workflow
  • Releases and version numbers
Feedback Form
Feedback sent!
  • .md

Page footer#

The page footer spans the entire width of the page, and is only visible once you scroll to the end of the article’s content.

By default, it is empty and not visible. However, there are two configuration points where you can add items to your footer:

html_theme_options["footer_start"] accepts a list of HTML templates that will be placed at the beginning (left on most screens) of the footer.

html_theme_options["footer_end"] accepts a list of HTML templates that will be placed at the end (right on most screens) of the footer.

For example, the configuration below assumes there is a template at _templates/test.html. It adds the _templates folder to Sphinx’s templates path, and adds the template to both the start and end section of the footer.

templates_path = ["_templates"]
html_theme_options = {
  "footer_start": ["test.html"],
  "footer_end": ["test.html"]
}

previous

Content footer

next

Header and navbar

Edit on GitHub
Show Source

Copyright © 2025

By Syft Theme Maintainer

Last updated on Jan 31, 2025.