Xanadu Sphinx Theme

Usage

API

  1. Docs
  2. Release notes

Release notes

This page contains the release notes for the Xanadu Sphinx theme.

Release 0.22.0 (development release)

Contributors

This release contains contributions from (in alphabetical order):

Release 0.21.0 (current release)

Bug fixes

  • Removed duplicate “tensorflow” copy in the footer.

  • Lowered the mobile/desktop breakpoint to 1324px.

Contributors

This release contains contributions from (in alphabetical order):

Koeun Lee

Release 0.20.0

Contributors

This release contains contributions from (in alphabetical order):

Koeun Lee

Features

  • Ported PennyLane’s new global navbar into the Sphinx theme.

    • On desktop it expands into a “mega menu” with multi-column sections and a slide-down animation.

    • On mobile it collapses into an accordion with expand/collapse animations.

    • Menus render featured cards along with content and latest-release cards that are loaded client-side when a menu first opens.

Bug fixes

  • Navbar menus now close automatically when switching between mobile and desktop breakpoints.

Release 0.19.0

Contributors

This release contains contributions from (in alphabetical order):

Ashish Kanwar Singh

Bug fixes

  • Fixed title cards and index cards so the entire card is clickable, not just the title text. Cards now use Bootstrap’s stretched-link pattern to cover the full card area.

  • Fixed gallery items so the full card (including the thumbnail image) is clickable when the description contains a link. Broadened the CSS overlay selectors to match all Sphinx figure caption markup variants.

Release 0.18.0

Contributors

This release contains contributions from (in alphabetical order):

Release 0.17.0

Contributors

This release contains contributions from (in alphabetical order):

Ashish Kanwar Singh

Bug fixes

  • Fixed an issue where local table of contents was missing in Catalyst documentation

Release 0.16.0

Contributors

This release contains contributions from (in alphabetical order):

Jon Toye

Features

  • Added Google Analytics event tracking functionality

    • Implemented sendCustomGAEvent function for tracking user interactions

    • Added safe no-op function when GA is disabled

    • Added event tracking for navbar and footer interactions

    • Improved event reliability with beacon transport

Release 0.15.0

Contributors

This release contains contributions from (in alphabetical order):

Jon Toye

Features

  • Update navbar and footer styling to match new designs (#93)

    • Update boxicons from v2 to v3 in order to use new twitter-x logo

    • Allow href for navbar_left_links to be optional, to support non-link headings

Release 0.14.0

Contributors

This release contains contributions from (in alphabetical order):

Ashish Kanwar Singh.

Features

  • Replaced jquery.nanoscroller with overlayscrollbars as recommended here.

  • Update JQuery implementation of right sidebar scroll logic to be in JavaScript.

Release 0.13.0

Contributors

Features

  • Update project to projects in search URL query string

Release 0.12.0

Contributors

Features

  • Update project filter to projects in search_options

Release 0.11.0

Contributors

Features

  • Update project filter to projects

Release 0.10.0

Contributors

This release contains contributions from (in alphabetical order):

Features

  • Fix build workflow

Release 0.9.1

Contributors

This release contains contributions from (in alphabetical order):

Features

  • Fix build workflow

Release 0.9.0

Contributors

This release contains contributions from (in alphabetical order):

Features

  • Project filter is now passed to search options when search_on_pennylane_ai is True

Release 0.8.0

Contributors

This release contains contributions from (in alphabetical order):

Features

  • Update name in setup.py so the build does not use - in the name. This is to comply with PEP 625, which is causing deprication warnings from PyPI

  • Update year in footer

  • Disable hotkeys in theme

Release 0.7.1

Contributors

This release contains contributions from (in alphabetical order):

Bug fixes

  • Fixed an issue with the command_palette_enabled and search_on_pennylane options having falsey values, big thanks to Mikhail Andrenkov. (#60)

Release 0.7.0

Contributors

This release contains contributions from (in alphabetical order):

Alan Martin,

Features

  • Embedded pennylane-command-palette, created button ui, and added a new command_palette_enabled option to the theme. (#57)

Release 0.6.2

Improvements

  • Updated python and action versions in upload.yml (#51) (#52)

Contributors

This release contains contributions from (in alphabetical order):

Ashish Kanwar Singh.

Release 0.6.1

Improvements

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov.

Release 0.6.0

Improvements

  • Pinned some implicit requirements in doc/requirements.txt. (#48)

  • Bumped the pinned versions of black and pillow. (#48)

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov.

Release 0.5.0

Improvements

  • Improved the accessibility of the navbar and footer by adding missing alt text and ARIA labels and fixing issues with keyboard navigation. (#44)

  • Added transition animations to the navbar dropdowns on mobile. (#45)

Bug fixes

  • Obviated the need for horizontal scrolling on mobile. (#42)

  • Prevented overlap of local ToC with footer. (#42)

  • Added missing Read the Docs configuration file. (#42)

  • Bumped pillow to version 10.0.1. (#43)

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov.

Release 0.4.0

Improvements

  • Updated the navbar and footer configuration and styles to match the PennyLane website. (#40)

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov.

Release 0.3.7

Improvements

  • Bumped wheel to v0.38.1. (#33)

Bug fixes

  • Fixed an issue where the dropdown_link Jinja variable is accessed but undefined. (#36)

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov.

Release 0.3.4

Bug fixes

  • Fixed an issue where the meta directive in ReST files was not properly registering an Open Graph Twitter card. (#29)

Contributors

This release contains contributions from (in alphabetical order):

Josh Izaac.

Release 0.3.4

Improvements

  • Added the option to customize the href fragment of the details directive (#26)

Contributors

This release contains contributions from (in alphabetical order):

David Wierichs.

Release 0.3.3

Bug fixes

  • Fixed an issue where footnote references were being rendered without brackets. (#25)

Contributors

This release contains contributions from (in alphabetical order):

Josh Izaac.

Release 0.3.2

Bug fixes

  • Added missing variables: github_repo and gallery_dirs to address the View on GitHub link not working for demos. (#24)

  • Fixed a bug where author bio photos would appear squished. (#25)

Contributors

This release contains contributions from (in alphabetical order):

Lucas Silbernagel Josh Izaac.

Release 0.3.1

Improvements

  • Added support for images in navbar links. (#21)

Bug fixes

  • Fixed a bug where the navbar would incorrectly display a drop shadow with small screen widths when the global TOC was active. (#20)

  • Fixed a bug where gallery card margins would not reduce on smaller width displays. (#22)

Contributors

This release contains contributions from (in alphabetical order):

Josh Izaac.

Release 0.3.0

Improvements

  • Added documentation. (#13)

  • Add a new .. bio:: directive, which supports inserting author bios. (#14)

  • Add support for Sphinx Gallery. (#14)

  • Add a new option toc_global which allows the left-hand global ToC sidebar to be disabled. (#14)

  • Update heading and navbar font to Quicksand. (#15)

  • Add new options to customize the footer: (#16)

    • footer_about set the ‘About’ section of the footer

    • footer_links to create columns of links

    • footer_social to customize social media icons

    • footer_tagline to set the tagline

  • Included autosummary templates within the Xanadu Sphinx Theme. The provided templates directory is available via xanadu_sphinx_theme.templates_dir() and can be added to the templates_path list variable in conf.py. (#18)

Bug fixes

  • Fixed a bug where the HTML sidebars were not properly configured. (#17)

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov, Josh Izaac.

Release 0.2.1

Improvements

  • Noto Sans is now imported using @import instead of @font-face for stability reasons. (#9)

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov

Release 0.2.0

New features since last release

  • Adds the toc_overview option, which allows the table of contents to optionally display the project title and a link to the documentation homepage. (#7)

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov, Josh Izaac.

Release 0.1.0

New features since last release

  • This is the initial public release.

Contributors

This release contains contributions from (in alphabetical order):

Mikhail Andrenkov, Tom Bromley, Josh Izaac.

Previous
Next