Skip to content

Releases: canonical/canonical-sphinx

canonical-sphinx 0.6.0

26 Feb 07:21
0.6.0
f7c6a4d

Choose a tag to compare

25 February 2026

What's new in 0.6.0

Stacked toctrees

When multiple toctree directives are present on a page, a divider will now appear between them. This provides better visual separation and allows for an extra level of organization.

image

Fixed in 0.6.0

  • #65 Inline code isn't highlighted in dark mode
  • #73 Level-3 headings lack a proper top margin
  • #110 Admonition styling is inconsistent
  • #118 html_theme isn't configurable downstream
  • #112 html_theme_options is overridden when html_title is set to an empty string
  • #113 tag.png has a transparent line on the right side

Contributors

We'd like to express a big thank you to everyone who contributed to this release:

jahn-junior,
mariaclara-sia,
medubelko,
minaelee,
nhennigan,
and rkratky

0.5.2

09 Jan 00:39
0.5.2
d2af649

Choose a tag to compare

Special thanks to the contributors that made this release happen: @jahn-junior, @medubelko and @steinbro

Full list of changes

New Contributors

Full Changelog: 0.5.1...0.5.2

0.5.1

14 Jul 00:47
d63d894

Choose a tag to compare

Special thanks to the contributors that made this release happen: @SecondSkoll, @dwilding, @izmalk, @tang-mm and @yhontyk

Full list of changes

  • chore: Sphinx version pin, refactor config to set appropriate default (#68) @SecondSkoll (#97)
  • feat: split commit and lint checks @SecondSkoll (#96)
  • Add ARIA role to the dropdown list @yhontyk (#95)
  • Make the "Edit the page button" edit again @izmalk (#93)
  • feat: drop python3.8 support, add 3.12 testing @SecondSkoll (#90)
  • Fix: rendering of empty product page link in header template @tang-mm (#94)
  • fix: use correct styles when hovering over feedback button, project name, doc title @dwilding (#92)
  • fix: change white links to blue links for dark systems @dwilding (#91)
  • Fix: epub build @SecondSkoll (#87)

New Contributors

Full Changelog: 0.4.1...0.5.0

0.4.1

08 Apr 04:57
f7e1ba3

Choose a tag to compare

What's Changed

Full Changelog: 0.4.0...0.4.1

0.4.0

07 Mar 00:29

Choose a tag to compare

What's Changed

  • Fix #47 use better dark/light colors for Sphinx AutoAPI by @johnlettman in #48
  • feat: add config value and changes to support epub build by @SecondSkoll in #63
  • fix: copyright year on PDF cover page template by @tang-mm in #66
  • feat: enable configuration options for PDF title and file name by @tang-mm in #67
  • fix: don't overwrite custom latex_elements configuration by @SecondSkoll in #76
  • Add custom edit button and remove links in footer by @medubelko in #74

New Contributors

Full Changelog: 0.3.0...0.4.0

0.3.0

05 Jan 23:07
ffcc469

Choose a tag to compare

Special thanks to the contributors that made this release happen: @SecondSkoll, @renovate and @renovate[bot]

Full list of changes

0.2.0

30 Sep 03:11
c7149c3

Choose a tag to compare

What's Changed

  • chore(deps): update development dependencies (non-major) by @renovate in #20
  • chore: fix call to add_config_value() by @tigarmo in #26
  • chore(deps): update dependency setuptools to v69.5.1 by @renovate in #23
  • chore(deps): update development dependencies (non-major) by @renovate in #29
  • chore(deps): update dependency tox-gh to v1.3.2 by @renovate in #28
  • chore(deps): update development dependencies (non-major) by @renovate in #31
  • chore(deps): update dependency setuptools to v71 by @renovate in #32
  • chore(deps): update development dependencies (non-major) by @renovate in #33
  • Add contributor listing by @ru-fu in #25
  • chore(deps): update development dependencies (non-major) by @renovate in #35
  • chore(css): add recent changes from the starter pack by @akcano in #36
  • chore(deps): update dependency setuptools to v72 by @renovate in #38
  • init.py: mark all entrypoints as parallel safe by @liushuyu in #43
  • chore(deps): update bugfixes by @renovate in #42
  • chore(deps): update dependency black to v24.8.0 by @renovate in #41
  • chore(deps): update dependency setuptools to v72.2.0 by @renovate in #44
  • chore(deps): update bugfixes by @renovate in #46
  • feat!: allows selective loading of extensions using optional dependencies by @SecondSkoll in #50
  • ci: add workflow to automate releases by @tigarmo in #53
  • chore(deps): update dependency ruff to v0.6.2 by @renovate in #45
  • fix: linkify myst extension fix for minimal install by @SecondSkoll in #54

New Contributors

Full Changelog: 0.1.0...0.2.0

0.1.0

16 Apr 18:32
0.1.0

Choose a tag to compare

Special thanks to the contributors that made this release happen: @lengau, @mr-cal, @renovate, @renovate[bot], @sergiusens, @syu-w and @tigarmo

Full list of changes

  • Various changes to update templates and assets with "upstream" @tigarmo (#21)
  • chore(deps): update development dependencies (non-major) @renovate (#19)
  • chore(deps): update dependency dev/pytest-cov to v5 @renovate (#17)
  • chore(deps): update dependency types/pyright to v1.1.356 @renovate (#18)
  • chore(deps): update development dependencies (non-major) @renovate (#15)
  • chore(deps): update softprops/action-gh-release action to v2 @renovate (#16)
  • chore(deps): update dependency setuptools to v69.2.0 @renovate (#14)
  • chore(deps): update dependency docs/sphinx-autobuild to v2024 @renovate (#13)
  • chore(deps): update development dependencies (non-major) @renovate (#12)
  • feat: draft implementation of extension and theme @tigarmo (#9)
  • chore(deps): update development dependencies (non-major) @renovate (#11)
  • chore(deps): update dependency setuptools to v69.1.1 @renovate (#10)
  • chore(deps): update development dependencies (non-major) @renovate (#8)
  • chore(deps): update release-drafter/release-drafter action to v6 @renovate (#7)
  • chore(deps): update dependency docs/sphinx-autobuild to v2024 @renovate (#5)
  • chore(deps): update dependency setuptools to v69.1.0 @renovate (#6)
  • chore(deps): update development dependencies (non-major) @renovate (#4)
  • chore(deps): update dependency dev/pytest to v8 @renovate (#3)
  • chore: rename from starbase to canonical-sphinx @tigarmo (#2)