Release notes

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

Release 0.6.0 (development release)

Contributors

This release contains contributions from (in alphabetical order):

Release 0.5.0 (current release)

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.

release_notes

 

Download Python script

 

Download Notebook

 

View on GitHub