Skip to main content
Ctrl+K
⚠️The latest release refactored our HTML, so double-check your custom CSS rules!⚠️
Logo image
  • Executable Books
  • PyPI

Topic Areas

  • Get started
  • Content and formatting
    • Special content blocks
    • PyData Theme Elements
    • Jupyter notebooks
    • Launch buttons for interactivity
  • Layout and major sections
    • Primary sidebar and navigation
    • Secondary sidebar and table of contents
    • Header and navbar
    • Content footer
    • Page footer
    • Announcement banners
  • Component customization
    • Logo and branding
    • Icon links and badges
    • Add a download page button
    • Buttons that link to source files
    • Add your own CSS rules
  • Reference of theme options
  • Contributing guide
    • Set up your development workflow
    • Architecture of the repository
    • Style and design
    • Testing infrastructure
    • Releases and version numbers
    • Translation workflow
    • Creating sub-themes
  • Changelog

Example pages

  • Kitchen Sink
    • Admonitions
    • API documentation
    • Blocks
    • Generic items
    • Images & Figures
    • Lists
    • Really Long Page Title because we should test sidebar wrapping
    • Structural Elements
    • Tables
    • Typography
  • Theme-specific elements
  • Sphinx extension styles
  • Jupyter notebooks
  • Thebe
  • Reference for Blog
  • NumPy docstrings
  • Comments
  • Show source
  • Suggest edit
  • Open issue
  • .md

Page footer

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_start"] 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

Announcement banners

By the Executable Book Project

© Copyright 2023.

Last updated on Jul 03, 2023.