v0.11.0rc1

What's Changed

• Correct the link to the pygments styles in styling.rst by @braxtons12 in #910
• ENH: Use toctree titles in the header navbar by @12rambau in #915
• add css helper for images optimized for both dark and light theme by @12rambau in #914
• set the content at the top of the page by @12rambau in #916
• ENH: Use bootstrap tooltip to display icons title by @12rambau in #924
• Add #searchbox to sidebar for "Hide Search Matches" link by @minrk in #925
• use hasdoc() for logo link by @drammock in #921
• Add EnOSlib's website in the gallery by @msimonin in #919
• Fix plausible loading by @StefanUlbrich in #909
• DOCS: Add sepal to the gallery by @12rambau in #927
• MAINT: Open issue when dependency prereleases fail by @jarrodmillman in #899
• Add expected pandas 1.5 warning by @jarrodmillman in #936
• FIX: use parent when self is use in a toctree by @12rambau in #938
• feat: add the indices to the optional sidebar components by @12rambau in #922
• Bump node-forge and webpack-dev-server by @dependabot in #883
• Build wheels for testing by @jarrodmillman in #939
• update Javascript dependencies by @drammock in #940
• Bump nth-check and optimize-css-assets-webpack-plugin by @dependabot in #882
• FIX: Don't filter images that support the dark theme by @QuLogic in #942
• FIX: use target color for footnotes by @12rambau in #962
• FIX: expand the bd-article-container by @12rambau in #964
• better document how to remove secondary sidebar by @12rambau in #949
• Align all the columns on the primary sidebar by @12rambau in #950
• MAINT: update icons to fit Fontawesome 6 by @12rambau in #963
• FIX: do not prettify primary sidebar html by @12rambau in #965
• ENH: Automatically shorten links for GitHub/GitLab by @12rambau in #957
• fix: improve display of table in the nbsphinx context by @12rambau in #954
• DOCS: Fixed file path of logos by @michaelweinold in #969
• Update pre-commit hooks by @jarrodmillman in #970
• fix: check the json switcher file by @12rambau in #917
• Test on Python 3.11 by @jarrodmillman in #972

New Contributors

• @braxtons12 made their first contribution in #910
• @minrk made their first contribution in #925
• @msimonin made their first contribution in #919
• @StefanUlbrich made their first contribution in #909
• @michaelweinold made their first contribution in #969

Full Changelog: v0.10.1...v0.11.0rc1

v0.10.1

What's Changed

• Don't test against prereleased dependecies by @jarrodmillman in #900

Full Changelog: v0.10.0...v0.10.1

v0.10.0

This release refactors the HTML structure of the theme, with the goal of making it more functional at mobile widths. There are several changes to the underlying HTML theme structure, so double-check any custom CSS rules.

Enhancements made

Sidebar and header improvements

• ENH: Simplify and speed up navigation bar links generation #878 (by @choldgraf by @choldgraf )
• ENH: Improve sidebar secondary config and logic #849 (@choldgraf)
• ENH: Move header items to sidebar on mobile #834 (@choldgraf)
• ENH: Search button shows up on mobile #832 (@choldgraf)

Style improvements

• ENH: Add light background to inline code #838 (@choldgraf)
• ENH: Allow admonitions to be style as a sidebar #836 (@drammock)
• ENH: Add ABlog support #796 (@choldgraf)

Documentation improvements

• DOC: Add comment to deprecate some CSS in future #848 (@drammock)
• DOCS: Update front page, contributing doc, and gallery code #825 (@choldgraf)

Other merged PRs

• NEW: Adding a section for footer-content like in sphinx-basic-ng #861 (@AakashGfude)
• ENH: suppress autocorrect/spellcheck/autocapitalize in search box #870 (@drammock)
• fix: update switcher color according to sidebar #880 (@12rambau)
• fix color of the search input #875 (@12rambau)
• Gallery #867 (@12rambau)
• Build docs w/ sphinx 5 #864 (@jarrodmillman)
• Fix links on homepage #853 (@saulshanabrook)
• Add download link icon to download links #850 (@choldgraf)
• DOCS: Improve sphinx-design card examples #885 (@timhoffm)
• DOCS: Add arviz website to example gallery #862 (@OriolAbril)
• DOC: Add comment to deprecate some CSS in future [#848]
• BUG: Fix links not clickable in versionmodified directives #877 (@AnirudhDagar)
• FIX: Fix equation scrolling behavior #872 (@choldgraf)
• FIX: Hide vert scrollbars on inline math #871 (@drammock)
• fix admonition-sidebar styling #847 (@drammock)
• Clarify analytics documentation #839 (@choldgraf)
• Bump terser from 4.8.0 to 4.8.1 #830 (@dependabot)
• Add plausible analytics #828 (@tupui)
• Refactor and modularize user guide #826 (@choldgraf)
• Update kitchen sink and script to update #819 (@choldgraf)
• Move publish to new workflow #816 (@choldgraf)
• Add push events for tags #815 (@choldgraf)
• Release Candidate: v0.10.0rc1 #813 (@choldgraf)
• Add dropdown support for Sphinx Design #812 (@choldgraf)

Contributors to this release

(GitHub contributors page for this release)

@12rambau | @AakashGfude | @albig | @AnirudhDagar | @Arsha-M | @bollwyvl | @bryevdv | @choldgraf | @chrisjsewell | @damianavila | @dependabot | @dopplershift | @drammock | @gilbertbw | @greschd | @jarrodmillman | @jorisvandenbossche | @jpmckinney | @kinow | @larsoner | @lwasser | @martinRenou | @melund | @mgeier | @mwaskom | @noritada | @OriolAbril | @oscargus | @QuLogic | @saulshanabrook | @solegalli | [@ThibHlln...

v0.10.0rc2

v0.10.0rc1...master@{2022-07-30}

(full changelog)

Enhancements made

• ENH: Add light background to inline code #838 (@choldgraf)
• ENH: Allow admonitions to be style as a sidebar #836 (@drammock)
• ENH: Move header items to sidebar on mobile #834 (@choldgraf)
• ENH: Search button shows up on mobile #832 (@choldgraf)
• ENH: Add ABlog support #796 (@choldgraf)

Documentation improvements

• DOC: Add comment to deprecate some CSS in future #848 (@drammock)
• DOCS: Update front page, contributing doc, and gallery code #825 (@choldgraf)

Other merged PRs

• fix admonition-sidebar styling #847 (@drammock)
• Clarify analytics documentation #839 (@choldgraf)
• Bump terser from 4.8.0 to 4.8.1 #830 (@dependabot)
• Add plausible analytics #828 (@tupui)
• Refactor and modularize user guide #826 (@choldgraf)
• Update kitchen sink and script to update #819 (@choldgraf)
• Move publish to new workflow #816 (@choldgraf)
• Add push events for tags #815 (@choldgraf)
• Release Candidate: v0.10.0rc1 #813 (@choldgraf)
• Add dropdown support for Sphinx Design #812 (@choldgraf)

Contributors to this release

(GitHub contributors page for this release)

@12rambau | @choldgraf | @dependabot | @drammock | @tupui

v0.10.0rc1

Release Candidate: v0.10.0 {2022-07-10}

Discussion here: #814

(full changelog)

New additions

• Add dropdown menu to header navigation #754 (@choldgraf)
• Announcement banners are now supported #722 (@choldgraf)
• Add support for Sphinx Design #746 (@drammock)
• Search is now a button with an overlay upon clicking #744 (@choldgraf)

Enhancements

• Scroll bar style is improved to fit the theme better #776 (@choldgraf)
• Main content now grows and shrinks to fill in whitespace #753 (@choldgraf)
• Dark theme support for: several PyData packages #723 version switcher (@choldgraf) | quotes #719 (@12rambau) | #743 (@12rambau) | nbsphinx #741 (@choldgraf) | toggle and copy buttons #767 (@choldgraf)
• Update topic and contents directive style #785 (@choldgraf)
• Style code blocks after GitHub #784 (@choldgraf)
• Add: Sourcelink and other Sphinx theme templates #714 (@12rambau)
• Better equations style #718 (@12rambau)

Bugs fixed

• FIX: Overflow content on configuration #772 (@choldgraf)
• FIX: Search bar and navigation dropdown style #770 (@choldgraf)
• FIX: Typos in readme #740 (@choldgraf)
• FIX: Rendering external URL in logo.link option #734 (@greschd)
• FIX: Make hover color work on version switcher #731 (@drammock)
• Fix header spacing #788 (@choldgraf)
• Fix typos, use logging.warning #787 (@kinow)
• force table to fit in the article width #717 (@12rambau)

Contributors to this release

Below is a list of people that contributed discussion, new ideas, code and documentation, and review of one another's work.

(GitHub contributors page for this release)

@12rambau | @bollwyvl | @bryevdv | @choldgraf | @chrisjsewell | @damianavila | @dopplershift | @drammock | @gilbertbw | @greschd | @jarrodmillman | @jorisvandenbossche | @jpmckinney | @kinow | @lwasser | @martinRenou | @melund | @mgeier | @mwaskom | @oscargus | @QuLogic | @solegalli | @tupui

v0.9.0

What's Changed

• Set lighthouse to run on kitchen sink by @choldgraf in #612
• Update black pre-commit by @choldgraf in #618
• Add a url type for navbar icons by @maximlt in #616
• Add dark theme and theme switcher by @12rambau in #540
• ENH: Dark theme support for ethical ads by @12rambau in #629
• ENH: Minor updates and tweaks to Dark theme CSS by @12rambau in #631
• DOC: Document helper for dark mode by @larsoner in #626
• Refactor SCSS structure by @choldgraf in #619
• Show the right sidebar on wider screens if the left is hidden by @jorisvandenbossche in #570
• ENH: Adapt target viewcode to tango highlighting style by @12rambau in #635
• FIX: Avoid secondary navbar overlap by @12rambau in #642
• DOCS: how to create an inline footer by @12rambau in #636
• Clarify use-case and docs structure by @choldgraf in #648
• Update example to correspond to new Google Analytics ID by @AdamRJensen in #650
• fix: apply the centered directive by @12rambau in #652
• customize display of line numbers in code-block by @12rambau in #651
• Update docs on version switcher dictionary by @melissawm in #653
• [switcher] default activeVersion and activeVersionName values by @tupui in #654
• Add deprecation warning for switcher by @choldgraf in #655
• Add missing release in version switcher by @tupui in #656
• control scrollbar styling by @12rambau in #637
• Fix scrollspy so TOC expands when sections are clicked by @choldgraf in #657
• ENH: Clean up navbar spacing on mobile by @choldgraf in #644
• This adds the mastodon fediverse icon as own option. by @albig in #646
• Rearrange sections to use basic-ng names by @choldgraf in #662
• Update pre-commit hooks by @jarrodmillman in #667
• Update GH actions versions by @jarrodmillman in #670
• Support Sphinx 5 by @jarrodmillman in #668
• Add classes for multi-theme content support by @12rambau in #673
• Add panels support by @12rambau in #641
• Remove upperbound on sphinx by @jarrodmillman in #661
• ENH: simplify color variables by @12rambau in #659
• Moving some template links to Python by @choldgraf in #672
• Rename master branch main by @jarrodmillman in #666
• Pin Sphinx to >= 4.0.2 by @choldgraf in #678
• Fix docs for configuring pygments themes by @philippjfr in #682
• Test against prereleases by @jarrodmillman in #683
• move all the CSS variable to a single folder by @12rambau in #686
• MAINT: Docutils 0.18 deprecation by @larsoner in #687
• Add Sphinx and Python version support policy by @choldgraf in #679
• Add acknowledgment section by @12rambau in #696
• Center align all elements in the navbar by @12rambau in #697
• Manage the bottom of small pages by @12rambau in #694
• Improve table captions by @12rambau in #695
• Prevent theme mamangement to raise error when the mode is fixed by @12rambau in #692
• Use different logos for light and dark theme by @12rambau in #691
• Style the toctree by @12rambau in #693
• Use myst-parser 0.18 by @jarrodmillman in #703
• Add logo and update brand colors by @choldgraf in #698

New Contributors

• @maximlt made their first contribution in #616
• @AdamRJensen made their first contribution in #650
• @melissawm made their first contribution in #653
• @albig made their first contribution in #646
• @philippjfr made their first contribution in #682

Full Changelog: v0.8.1...v0.9.0

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.