Sphinx-wagtail-theme

Added

- Add basic styling of `autodoc` generated methods for readability (Temidayo Azeez)

Removed

- Remove Algolia DocSearch meta tags (Thibaud Colas)
- Remove jQuery loading by default (LB (Ben) Johnston)

Upgrade considerations

For projects relying on Algolia DocSearch meta tags, make sure to add back the `docsearch:version` tag in your project:

html
<meta name="docsearch:version" content="{{ version|striptags|e }}" />

Added

- Add search input attributes for better search compatibility with screen readers and mobile devices (LB (Ben) Johnston)
- Add skip to main content link for keyboard only and screen reader users (LB (Ben) Johnston)

Fixed

- Fix `make test-import` to correctly use the `__version_full__` value (Andy Chosak)
- Ensure version picker correctly shows above right sidebar (LB (Ben) Johnston)
- Fix underline colour regression to ensure it is not the same as the link colour (LB (Ben) Johnston)

Added

- Add ability to copy code snippets using `sphinx_copybutton` (Mohammad Areeb)

Changed

- Update page contents (right sidebar) to ensure horizontal scrollbars do not appear (Kartik Kankurte)

Fixed

- Resolve further issues with links in Safari not showing correctly, especially in dark mode (LB (Ben) Johnston)
- Ensure that the dark mode toggle does not clear existing body classes (LB (Ben) Johnston)
- Fix issue where dark mode theme would flash incorrectly on load (LB (Ben) Johnston)

Added

- Add Dark mode 🧛 - you can now feel more at home with the Wagtail docs if you choose to in your device preferences or manually (Vince Salvino)
- Add layout scss to fix some global style issues (LB (Ben) Johnston)
- Add a consistent and high contrast focus outline to focusable (tabbable) elements (LB (Ben) Johnston, Vince Salvino)

Changed

- Use variable for the `max-width` of the version picker in styles (LB (Ben) Johnston)
- Sidebar will have a right border (when on the side) and a maximum width on large breakpoints (LB (Ben) Johnston)
- Set language to `en` for this project's documentation (Vince Salvino)
- Docs buttons such as View source, Edit source, and Dark mode will now show on small devices (Vince Salvino, LB (Ben) Johnston)
- Ensure the table of contents expand button can be focused with a keyboard (LB (Ben) Johnston)

Removed

- Source Code Pro is no longer included in this theme, instead the Wagtail system font stack is used (Vince Salvino)

Fixed

- Fix gap after content within admonitions, avoid styling every last element inside, only the container (LB (Ben) Johnston)
- Resolve issues with sidebar container and overflow scroll, add padding so that visible scrollbars (Windows) does not cut into content (LB (Ben) Johnston)
- Avoid using coded styles when bootstrap utility classes are suitable in the sidebar & search box (LB (Ben) Johnston)
- Fix documentation syntax error in example `conf.py` (Vince Salvino)
- Avoid hard-coding the `/` for the root path to the logo as documentation may not be served at the root path (Vince Salvino)
- Fix focus outline on search box so (Vince Salvino)

Added

- Page table of contents made sticky and scrollable ([167](https://github.com/wagtail/sphinx_wagtail_theme/pull/167))
- Stylelint checks are now functional and included in CI, these now extend `wagtail/stylelint-config-wagtail` ([173](https://github.com/wagtail/sphinx_wagtail_theme/pull/173))
- Adopt eslint with shared Wagtail project rules ([180](https://github.com/wagtail/sphinx_wagtail_theme/pull/180))
- Add build instructions for Windows ([157](https://github.com/wagtail/sphinx_wagtail_theme/pull/157))

Changed

- Distinguished the caption text visually from the body text ([166](https://github.com/wagtail/sphinx_wagtail_theme/pull/166))
- Clean up frontend dependences ([168](https://github.com/wagtail/sphinx_wagtail_theme/pull/168))
- `make install-for-dev` has been changed to `make install-for-development` and explicit development requirements have been added ([162](https://github.com/wagtail/sphinx_wagtail_theme/pull/162))

Fixed

- De-emphasize page table of contents ([159](https://github.com/wagtail/sphinx_wagtail_theme/pull/159))
- Fix links not styled properly in Safari ([160](https://github.com/wagtail/sphinx_wagtail_theme/pull/160))
- Fix issue where RTD build would not work since the adoption of MYst Parser ([162](https://github.com/wagtail/sphinx_wagtail_theme/pull/162))
- Fix scrolling issues on shorter viewports with a long table of contents ([178](https://github.com/wagtail/sphinx_wagtail_theme/pull/178))

Fixed

- Fix code highlight, exclude pygments css from layout ([154](https://github.com/wagtail/sphinx_wagtail_theme/pull/154))