Sphinx-wagtail-theme

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))

See new [customising docs](https://sphinx-wagtail-theme.readthedocs.io/en/latest/customizing.html) for info on how to change fonts, sidebars, etc. in this version.

Added

- Massively improved autocomplete ([123](https://github.com/wagtail/sphinx_wagtail_theme/pull/123))
- Make navigation sticky ([110](https://github.com/wagtail/sphinx_wagtail_theme/pull/110))
- Use language specified by Sphinx in HTML tag ([116](https://github.com/wagtail/sphinx_wagtail_theme/pull/116))
- Add customising documentation ([118](https://github.com/wagtail/sphinx_wagtail_theme/pull/118))
- Style version added/changed/deprecated directives ([119](https://github.com/wagtail/sphinx_wagtail_theme/pull/119))
- Search autocomplete improvements ([123](https://github.com/wagtail/sphinx_wagtail_theme/pull/123))
- Allow customising the sidebar ([124](https://github.com/wagtail/sphinx_wagtail_theme/pull/124))
- Use sphinx-provided JavaScript files (documentation_options.js) ([114](https://github.com/wagtail/sphinx_wagtail_theme/pull/114))
- **NOTE** You should set `language = "en"` in your project's `conf.py`

Changed

- Ignore pyenv python-version file ([146](https://github.com/wagtail/sphinx_wagtail_theme/pull/146))
- Clean-up make file ([150](https://github.com/wagtail/sphinx_wagtail_theme/pull/150))
- Update development instructions ([149](https://github.com/wagtail/sphinx_wagtail_theme/pull/149))
- Update node version usage from v14 to v16 ([132](https://github.com/wagtail/sphinx_wagtail_theme/pull/132))
- Replace "Apercu Pro" font with "Source Sans" ([122](https://github.com/wagtail/sphinx_wagtail_theme/pull/122))
- Update colours for success/info/warning admonitions to match reference designs (Paarth Agarwal [137](https://github.com/wagtail/sphinx_wagtail_theme/pull/137))
- Migrate from `recommonmark` to [`MyST Parser`](https://myst-parser.readthedocs.io/) for markdown usage in documentation ([#142](https://github.com/wagtail/sphinx_wagtail_theme/pull/142))

Fixed

- Fix link states ([152](https://github.com/wagtail/sphinx_wagtail_theme/pull/152))
- Remove unused Typo3 version selector code ([123](https://github.com/wagtail/sphinx_wagtail_theme/pull/123))
- Don't load webfonts.css since it's been removed and 404s ([111](https://github.com/wagtail/sphinx_wagtail_theme/pull/111))
- Remove invalidly named file path preventing git clone on Windows ([112](https://github.com/wagtail/sphinx_wagtail_theme/pull/112))
- Fix sphinx-based search ([113](https://github.com/wagtail/sphinx_wagtail_theme/pull/113))
- Use `<main>` tag for body content ([117](https://github.com/wagtail/sphinx_wagtail_theme/pull/117))
- Fix copyright and date in footer ([118](https://github.com/wagtail/sphinx_wagtail_theme/pull/118))
- Increase contrast of admonitions to WCAG AAA, inline code to AA ([121](https://github.com/wagtail/sphinx_wagtail_theme/pull/121))
- Fix appearance of links within code blocks ([127](https://github.com/wagtail/sphinx_wagtail_theme/pull/127))
- Fix issue where core styles for content such as autodoc were not being used (Paarth Agarwal [136](https://github.com/wagtail/sphinx_wagtail_theme/pull/136))
- Fix build issue due to jinja2 compatibility ([142](https://github.com/wagtail/sphinx_wagtail_theme/pull/142))
- Fix issue where Sphinx default pygments styles were being imported but not required ([151](https://github.com/wagtail/sphinx_wagtail_theme/pull/151))