v0.9.0rc1

v0.8.1...v0.9.0rc1

(full changelog)

Enhancements made

• ENH: simplify color variables #659 (@12rambau)
• ENH: Clean up navbar spacing on mobile #644 (@choldgraf)
• ENH: Adapt target viewcode to tango highlighting style #635 (@12rambau)
• ENH: Minor updates and tweaks to Dark theme CSS #631 (@12rambau)
• ENH: Dark theme support for ethical ads #629 (@12rambau)

Bugs fixed

• FIX: Avoid secondary navbar overlap #642 (@12rambau)

Documentation improvements

• DOCS: how to create an inline footer #636 (@12rambau)
• DOC: Document helper for dark mode #626 (@larsoner)

Other merged PRs

• Pin Sphinx to >= 4.0.2 #678 (@choldgraf)
• Add classes for multi-theme content support #673 (@12rambau)
• Moving some template links to Python #672 (@choldgraf)
• Update GH actions versions #670 (@jarrodmillman)
• Support Sphinx 5 #668 (@jarrodmillman)
• Update pre-commit hooks #667 (@jarrodmillman)
• Rename master branch main #666 (@jarrodmillman)
• Rearrange sections to use basic-ng names #662 (@choldgraf)
• Remove upperbound on sphinx #661 (@jarrodmillman)
• Fix scrollspy so TOC expands when sections are clicked #657 (@choldgraf)
• Add missing release in version switcher #656 (@tupui)
• Add deprecation warning for switcher #655 (@choldgraf)
• [switcher] default activeVersion and activeVersionName values #654 (@tupui)
• Update docs on version switcher dictionary #653 (@melissawm)
• fix: apply the centered directive #652 (@12rambau)
• customize display of line numbers in code-block #651 (@12rambau)
• Update example to correspond to new Google Analytics ID #650 (@AdamRJensen)
• Clarify use-case and docs structure #648 (@choldgraf)
• This adds the mastodon fediverse icon as own option. #646 (@albig)
• Add panels support #641 (@12rambau)
• control scrollbar styling #637 (@12rambau)
• Refactor SCSS structure #619 (@choldgraf)
• Update black pre-commit #618 (@choldgraf)
• Add a url type for navbar icons #616 (@maximlt)
• Set lighthouse to run on kitchen sink #612 (@choldgraf)
• RELEASE: v0.8.1 #611 (@choldgraf)
• Show the right sidebar on wider screens if the left is hidden #570 (@jorisvandenbossche)
• Add dark theme and theme switcher #540 (@12rambau)

Contributors to this release

(GitHub contributors page for this release)

@12rambau | @AdamRJensen | @albig | @choldgraf | @damianavila | @djhoese | @flying-sheep | @HealthyPear | @hoetmaaiers | @jarrodmillman | @jorisvandenbossche | @larsoner | @maximlt | @melissawm | @pradyunsg | @tupui

v0.8.1

Enhancements made

Left navigation menu to collapse at the "part" level

ref: #594 (@AakashGfude)

Version switcher with pre-defined URLs

ref: #575 (@tupui) | #604 (@choldgraf)

The version switcher dropdown now uses a hard-coded URL for each version. This results in less brittle/breaking behavior over time, especially if you want to change the URL structure of old versions.

Style changes

• Anchor links are now a # by default, and have nicer hovering behavior. ref: #593 (@choldgraf)
• Sidebar search style is now improved. ref: #578 (@pradyunsg)

v0.8.0

This release brings in a number of new UI improvements and CSS bugfixes. It cleans up the layout of the site a bit more and gives you more customizability over several elements. In addition, we've done an overhaul of our contributing and demo site documentation.

Enhancements

• You can now add a version switcher to switch between documentation versions #436 (@drammock)
• There is now a "bottom" section in the left sidebar that always remains at the bottom of the screen regardless of sidebar content. This is for things like advertisements and buttons you don't want to move. #543 (@choldgraf)
• You can now include your own SVG / PNG images when creating icon links #542 (@choldgraf)
• You can now configure the depth of the sidebar navigation that is shown by default #493 (@choldgraf)

Bugs fixed

• Field lists bug #554 (@choldgraf)
• Admonitions margin #550 (@choldgraf)
• Navbar margin on mobile #541 (@choldgraf)
• Left scroll JS proper selector #534 (@choldgraf)
• Compatibility with sphinx 4.3 (visit_table) #509 (@jorisvandenbossche)

Maintenance and upkeep improvements

• We now test this theme on OSX and Windows #533 (@choldgraf)

Documentation improvements

• DOCS: Refactor demo docs #544 (@choldgraf)
• DOCS: refactor developer docs #538 (@choldgraf)

Contributors to this release

(GitHub contributors page for this release)

@12rambau | @astrojuanlu | @bollwyvl | @bryevdv | @choldgraf | @damianavila | @dopplershift | @drammock | @greglucas | @jbednar | @jorisvandenbossche | @larsoner | @mattip | @MegChai | @OriolAbril | @pradyunsg | @rgommers | @ThuWangzw | @tupui | @yhuang85

v0.7.2

This is a patch release that includes a fix for compatibility with sphinx 4.3.

v0.7.1

This is a patch release that includes a fix for translations in the "previous" and "next" buttons.

v0.7.0

v0.7.0

(full changelog)

Merged PRs

• Fixing admonition title CSS #407 (@choldgraf)
• Update API styling for changes in sphinx 4.x #485 (@jorisvandenbossche)
• Add css for blockquote and references/citations #482 (@yhuang85)
• Avoid adding margin to docutils container (from bootstrap container) #474 (@jorisvandenbossche)
• Improve styling of the Previous / Next buttons #473 (@choldgraf)
• 👌 Round edges #472 (@choldgraf)
• Bump docutils version #463 (@choldgraf)
• revert style changes #459 (@akhmerov)
• include tests in sdist #457 (@bollwyvl)
• Add explicit heading aria-level to complement heading role #456 (@bollwyvl)
• move parent theme css earlier in the inclusion order #451 (@akhmerov)
• TST: update role for caption in expected html output (sphinx 4.1) #441 (@jorisvandenbossche)
• FIX: added gtag date and moved google analytics to header #439 (@jackminchin)
• fix Fairlearn link #430 (@romanlutz)
• DOC: Add a few more projects that have adopted the theme. #423 (@rossbar)
• add pyvista to sites using the theme #418 (@akaszynski)
• Use a variable for the color of editthispage #412 (@12rambau)
• Remove end tags from HTML elements #408 (@ajschmidt8)
• Add MNE-Python to theme users list #405 (@drammock)
• Add pa11y testing and reporting #294 (@bollwyvl)

Contributors to this release

(GitHub contributors page for this release)

@12rambau | @ajschmidt8 | @akaszynski | @akhmerov | @astrojuanlu | @bollwyvl | @choldgraf | @chrisjsewell | @dependabot | @drammock | @erogluorhan | @greglucas | @hoetmaaiers | @isabela-pf | @jackminchin | @jorisvandenbossche | @jpmckinney | @lwasser | @MegChai | @mwaskom | @pradyunsg | @romanlutz | @rossbar | @scottyhq | @SebastianJL | @timhoffm | @tupui | @yhuang85

v0.6.3

v0.6.3

• Fix regression with 'None' inserted in html by google analytics script #404

v0.6.2

v0.6.2

Fixes a compatibility issue with the latest jinja2 version.

Merged PRs

• CI: add build with pre-release versions of sphinx and jinja2 #402 (@jorisvandenbossche)
• i18n: Translate theme text variable #398 (@jpmckinney)
• i18n: Translate text in HTML #397 (@jpmckinney)
• i18n: Translate aria-label #396 (@jpmckinney)
• 🐛 FIX: fix undefined sphinx var "meta" in jinja #395 (@drammock)
• Raise exception if icon_links conf val is not a dict. #392 (@rossbar)
• Support new+old Google analytics #387 (@FabioRosado)

Contributors to this release

(GitHub contributors page for this release)

@choldgraf | @drammock | @FabioRosado | @jorisvandenbossche | @jpmckinney | @rossbar

v0.6.1

v0.6.1

Merged PRs

• Add NetworkX to the list of projects using the theme #390 (@jarrodmillman)
• Making expandable/collapsible sidebar navigation + navigation depth configurable #386 (@jorisvandenbossche)
• 🐛 FIX: fix navbar-end CSS #384 (@drammock)
• Fix user-select bug for safari #380 (@V0lantis)

Contributors to this release

(GitHub contributors page for this release)

@choldgraf | @drammock | @jarrodmillman | @jorisvandenbossche | @V0lantis

v0.6.0

v0.5.2...v0.6.0

(full changelog)

Enhancements made

• ✨ ENH: Scroll to active page in navigation left sidebar #363 (@jorisvandenbossche)
• ✨ ENH: Collapsible sections in the sidebar #349 (@jorisvandenbossche)
• ✨ ENH: Support captions in sidebar toctree #346 (@jorisvandenbossche)
• Making navbar + a few other sections more modular #355 (@choldgraf)
• Add favicons option for defining multiple favicons #359 (@tcmetzger)

Documentation improvements

• CI/DOC: Pin docutils to 0.16 #368 (@jorisvandenbossche)

Other merged PRs

• FIX height of the sidebar #374 (@jorisvandenbossche)
• Add scripts_end block and banner div to base layout.html #375 (@jorisvandenbossche)
• 🪣 🧫 🛃 Add bitbucket, gitlab, and custom edit buttons #372 (@bollwyvl)
• Add MegEngine to the list of projects using the theme #371 (@MegChai)
• Update index.rst #370 (@bryevdv)
• Add SciPy to the list of projects using the theme #369 (@tupui)
• Add CSS variables for code color + sidebar font size #366 (@jorisvandenbossche)
• 👌 Add external link icon to external links in sidebar #365 (@jorisvandenbossche)
• Bump y18n from 4.0.0 to 4.0.1 #362 (@dependabot)
• add badges, minimal codecov, mk2 #352 (@bollwyvl)
• Add codecov and coverage threshold, hoist test requirements to setup.py #348 (@bollwyvl)

Contributors to this release

(GitHub contributors page for this release)

@bollwyvl | @bryevdv | @choldgraf | @dependabot | @drammock | @jorisvandenbossche | @MegChai | @tcmetzger | @tupui