Make TOC sections expandable and collapsible by keyboard #1582
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* wip * Style focus state in header nav * update focus ring style on all focussable elements * simplify * fix links in mobile sidebar overlay * put focus rings around a few more focusable elements * polish * update comment * review * better align focus ring on collapsible admonitions * comment and simplify sphinx-togglebutton focus ring * make css override more explicit * Fix SD link-card focus ring and on homepage, bring links inside card * Update docs/index.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info>
* Fix sidebar current notch * focus-ring-radius * missed a spot 0.125rem * keep focus ring on top
* restyle sphinx design tabs * increase panel border radius * increase line height, zero padding-y * use shadow variable * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss
|
I'm putting this up as a draft PR right now in order to get a preview build |
drammock
force-pushed
the
feature-focus
branch
from
bdfa1dd
to
4839dc2
Compare
trallard
added
the
tag: accessibility
gabalafou
force-pushed
the
keyboardable-toc-chevrons
branch
from
95f82f0
to
eda8049
Compare
gabalafou
commented
Dec 19, 2023
Comment on lines
145
to
147
| .nav { | ||
| display: block; | ||
| } |
There was a problem hiding this comment.
I'm not totally sure what I'm doing here. The display: block rule here overrides a display: none rule on line 12 in _toc-inpage.scss, but I don't fully understand what the rules in _toc_inpage.scss are about.
There was a problem hiding this comment.
Going by the comments in toc-inpage.scss that display: none seems to be related to https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/navigation.html#collapse-entire-toctree-captions-parts
so that the user can make those collapsible or specify the level through the config.py
There was a problem hiding this comment.
I dig some digging on this. I decided that it probably makes most sense to remove the .list-caption selector from the in-page-TOC stylesheet, which is what I did in my latest commit, 85f2ad1.
Semantically, I don't think that the .list-caption class (introduced in #594) should have ever been added to that stylesheet. As far as I can tell, the class is only applied in the left sidebar, whereas the in-page-TOC stylesheet is for the right sidebar. So why was it added to that stylesheet? I'm not sure. Maybe it was to pick up some of the other rules in that block of styles? In any case, it doesn't seem necessary now, and removing .list-caption from that stylesheet allows me to remove the display: block override, as well as make that stylesheet more semantically coherent.
As for your hunch, @trallard, I think it's close. It looks to me that the CSS block in the in-page-TOC stylesheet is related to show_toc_level, which is similar to but different from show_nav_level. I think the first one applies to the right sidebar whereas the second applies to the left. See #256.
There was a problem hiding this comment.
Here's a screenshot of the website with:
.list-captionremoved from_toc-inpage.scssshow_nav_level= 0show_toc_level= 4
It looks right to me. I also clicked around, and things looked right. As far as I can tell, the .list-caption is only used in the left sidebar and only when show_nav_level is set to 0.
Comment on lines
-29
to
-54
|
|
||
| /** | ||
| * Togglable expand/collapse | ||
| * This is only applicable to the primary sidebar which has these checkboxes | ||
| */ | ||
| .toctree-checkbox { | ||
| position: absolute; | ||
| display: none; | ||
| } | ||
|
|
||
| .toctree-checkbox { | ||
| ~ ul { | ||
| display: none; | ||
| } | ||
| ~ label .fa-chevron-down { | ||
| transform: rotate(0deg); | ||
| } | ||
| } | ||
| .toctree-checkbox:checked { | ||
| ~ ul { | ||
| display: block; | ||
| } | ||
| ~ label .fa-chevron-down { | ||
| transform: rotate(180deg); | ||
| } | ||
| } |
There was a problem hiding this comment.
No more of the label/checkbox implementation (replaced in this PR with details/summary)
| width: 30px; | ||
| position: absolute; | ||
| top: 0.3em; // aligning chevron with text | ||
| right: 0em; // aligning chevron to the right | ||
| } |
There was a problem hiding this comment.
The other parts of this PR suggest that this class was applied to the label element when styling the toggle icon for a level 0 heading. It's purpose, I think was to make the entire heading clickable. I refactored all of this so that the heading and the icon is put inside a summary tag, which makes the whole heading and the icon clickable.
| @@ -1,4 +1,4 @@ | |||
| <li class="nav-item current active"> | |||
| <li class="nav-item pst-header-nav-item current active"> | |||
There was a problem hiding this comment.
I didn't add this class in this PR, but this PR branches off of the feature-focus branch, which added this class but didn't update the tests yet.
| </a> | ||
| </li> | ||
| </ul> | ||
| <details open=""> |
There was a problem hiding this comment.
Note to reviewer: please double check me that this markup structure (here and in the other test file snapshots) matches the comments I added in toctree.py
There was a problem hiding this comment.
It seems to be in alignment, though I left a comment on the boolean syntax for consideration.
trallard
reviewed
Feb 5, 2024
There was a problem hiding this comment.
Thanks @gabalafou, I finally managed to finish the review.
I tested in Brave, Firefox, and Sarafi and this is working as expected. I left a couple of comments (for my understanding and some small suggestions). I could not spot any big gaps or issues so we should be able to merge pretty soon.
| @@ -364,7 +360,7 @@ def add_collapse_checkboxes(soup: BeautifulSoup) -> None: | |||
| if "current" in classes: | |||
| parentli = element.find_parent("li", class_="toctree-l0") | |||
| if parentli: | |||
| parentli.select("p.caption ~ input")[0].attrs["checked"] = "" | |||
| parentli.find("details")["open"] = None | |||
There was a problem hiding this comment.
nice side effect of using details this is way more readable than the original one
tests/test_build.py
Outdated
| input_elem = sidebar.select("input") | ||
| # get all <details> elements | ||
| details_elem = sidebar.select("details") | ||
| assert len(details_elem) |
There was a problem hiding this comment.
Assuming we want to ensure the list is not empty I'd suggest
Suggested change
| assert len(details_elem) | |
| assert len(details_elem)>0, "The list must have at least one element" |
| # .toctree-toggle | ||
| # ul | ||
| # | ||
| # (2) Otherwise, if the node holds a link to a page in the docs: |
There was a problem hiding this comment.
I am struggling to grapple some of the specifics so apologies if this does not make sense at all. Why does it only matter for case 1) that show_nav_level == 0 and not here?
There was a problem hiding this comment.
Good question. This is fairly complicated to explain.
Let's begin by reviewing the levels of navigation on the site:
- sections within site (user guide, contributor guide, examples)
- parts within a section (within contributor guide: contributor guide, team practices, about the project)
- pages within a part (e.g., contributor guide / contributor guide / get started with development)
- (optional) sub-pages, and sub-pages of sub-pages, and so on
- heading within page or sub-page (e.g. contributor guide / contributor guide / get started with development / workflow for contributing changes)
The first level is put in the top nav, all the other levels are put in the left sidebar, except the last level, the within (sub)page level, which is put in the right sidebar.
Normally, when the table of contents is generated for the left sidebar, several nested tree structures using HTML lists of nested lists are created to capture each group of pages and sub-pages within a part, but the parts themselves are rendered outside of these nested list structures.
However, when show_nav_level == 0 the generate_toctree_html() function modifies the HTML so that the section parts become part of the nested list-of-lists structure.
Note that this part of the code you've asked about is in a function called add_collapse_checkboxes. This function goes through every list item in the nested list structure it receives, and if that list item contains a list, then it decorates the HTML so that that list item can be toggled open or closed.
But here's the catch. Unlike the pages and sub-pages (nav level > 0), the section parts (nav level = 0) are not links; there is no URL and no page in the site that maps to any section part.
This is the key issue. Every node in the sidebar table of contents is a link except for the section headings, which are all 0th-level nodes in the sidebar (or 1st-level nodes if you consider the "Section Navigation" heading at the top to be the root node for the entire sidebar TOC).
To reiterate, the key difference is that section nodes are not links, whereas page and sub-page nodes are. When a node is a link, we have to think about whether we want to put the link inside the summary tag or not. Why? If we put a link in a summary tag, we introduce an ambiguity: is the link click to expand/collapse or to navigate to a new page? I made the decision that the link click should be a link click and not an expand/collapse. However, I saw no reason why the user shouldn't be able to click the text of the section part to expand/collapse the details/summary, since a section part is not a link.
When show_nav_level > 0, the section parts are rendered outside of the list-of-lists structure, so they are never even visited by this add_collapse_checkboxes function.
There was a problem hiding this comment.
I just updated the code comment here. Hopefully, it's slightly clearer, or at least more precise, now.
There was a problem hiding this comment.
Thanks for the in-depth explanation; this makes sense. I went through the rest of the PR again and could not spot any obvious gotchas. So, I am happy to approve it as is.
That being said I know @drammock is a lot more familiar with the whole parsing/HTML generation side of things so I want to give him the chance to go over this or I can merge in a couple of days.
| </a> | ||
| </li> | ||
| </ul> | ||
| <details open=""> |
There was a problem hiding this comment.
It seems to be in alignment, though I left a comment on the boolean syntax for consideration.
gabalafou
commented
Feb 10, 2024
Co-authored-by: Tania Allard <taniar.allard@gmail.com>
trallard
approved these changes
Feb 12, 2024
| # .toctree-toggle | ||
| # ul | ||
| # | ||
| # (2) Otherwise, if the node holds a link to a page in the docs: |
There was a problem hiding this comment.
Thanks for the in-depth explanation; this makes sense. I went through the rest of the PR again and could not spot any obvious gotchas. So, I am happy to approve it as is.
That being said I know @drammock is a lot more familiar with the whole parsing/HTML generation side of things so I want to give him the chance to go over this or I can merge in a couple of days.
drammock
approved these changes
Feb 12, 2024
Comment on lines
+158
to
+159
| // Prevent toggle icon from getting squished by summary being a | ||
| // flexbox |
There was a problem hiding this comment.
just want to say I really appreciate comments like this in the CSS. Makes reviewing so much easier when the intent is clear.
drammock
added a commit
that referenced
this pull request
Apr 16, 2024
* Consistent focus ring (first pass) (#1549) * wip * Style focus state in header nav * update focus ring style on all focussable elements * simplify * fix links in mobile sidebar overlay * put focus rings around a few more focusable elements * polish * update comment * review * better align focus ring on collapsible admonitions * comment and simplify sphinx-togglebutton focus ring * make css override more explicit * Fix SD link-card focus ring and on homepage, bring links inside card * Update docs/index.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Resolve current sidebar link notch and focus ring (#1561) * Fix sidebar current notch * focus-ring-radius * missed a spot 0.125rem * keep focus ring on top * Restyle Sphinx Design tabs (#1555) * restyle sphinx design tabs * increase panel border radius * increase line height, zero padding-y * use shadow variable * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Fix tabbed panel colors (#1567) * Header nav link styles (focus, hover, current) (#1545) * Implement header nav link styles * add comments * add comment * changes from implementation review * Consistent focus ring (first pass) (#1549) * wip * Style focus state in header nav * update focus ring style on all focussable elements * simplify * fix links in mobile sidebar overlay * put focus rings around a few more focusable elements * polish * update comment * review * better align focus ring on collapsible admonitions * comment and simplify sphinx-togglebutton focus ring * make css override more explicit * Fix SD link-card focus ring and on homepage, bring links inside card * Update docs/index.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Resolve current sidebar link notch and focus ring (#1561) * Fix sidebar current notch * focus-ring-radius * missed a spot 0.125rem * keep focus ring on top * Restyle Sphinx Design tabs (#1555) * restyle sphinx design tabs * increase panel border radius * increase line height, zero padding-y * use shadow variable * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Fix tabbed panel colors (#1567) * update feature focus (#1569) * docs: add instructions for custom SVG icons (#1490) * docs: add instructions for custom SVG icons * docs: minor tweaks in SVG icon instructions * docs: some more tweaks to SVG icon instructions * Update docs/user_guide/header-links.rst Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * Change literalinclude to code-block in header links * Update docs/user_guide/header-links.rst Co-authored-by: Daniel McCloy <dan@mccloy.info> * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst --------- Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: make table background transparent (#1546) * fix: make table background transparent * fix: make table background transparent * fix: add color-theme option to html tag (#1536) * Silence warnings (#1542) * avoid webpack warning during asset compile * avoid frozen modules warning during import * try to make jupyterlite quieter * add config option to silence warnings * fix tests * add docs * hide conditional warning logic in utils * bump: 0.14.2 → 0.14.3 * chore: back to dev * docs: add the list of component using a directive (#1476) * fix: create the component list automatically * fix: read the first comment as documentation * docs: add disclaimer on .html suffix * docs: document every component with a simple one liner * fix: use regex to identify comments * update component branch (#15) * Change default logo alt text (#1472) * Default logo alt text only if no extra text * change default logo * use docstitle as default logo alt text * update docs to reflect change * Apply suggestions from code review Co-authored-by: Daniel McCloy <dan@mccloy.info> * use string formatting operator * Update docs/user_guide/branding.rst * docs fixes * Update docs/user_guide/branding.rst * add test * Update pyproject.toml * revert to original --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * chore(i18n) catalan (#1488) i18n: Translate sphinx.po in ca 100% translated source file: 'sphinx.po' on 'ca'. Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * Build(deps): Bump postcss and css-loader (#1494) Bumps [postcss](https://github.com/postcss/postcss) to 8.4.31 and updates ancestor dependency [css-loader](https://github.com/webpack-contrib/css-loader). These dependencies need to be updated together. Updates `postcss` from 8.4.21 to 8.4.31 - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/postcss/compare/8.4.21...8.4.31) Updates `css-loader` from 3.6.0 to 6.8.1 - [Release notes](https://github.com/webpack-contrib/css-loader/releases) - [Changelog](https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/css-loader/compare/v3.6.0...v6.8.1) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect - dependency-name: css-loader dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Revert "Build(deps): Bump postcss and css-loader" (#1509) Revert "Build(deps): Bump postcss and css-loader (#1494)" This reverts commit 185a37aa36820f77bffa4c87a772092e9e7cc380. * Update pst docs buttons (#1502) * call them button-links * copy edit * docs: link back to GitHub from PyPI metadata (#1504) This will add a "Source" link in the PyPI page. * navigation_with_keys = False (#1503) * navigation_with_keys = False * None -> False * Apply suggestions from code review --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: convert "stable" to actual version number (#1512) * convert "stable" to actual version number * fix tests re: navigation_with_keys * try bumping autoapi * refactor: use nbsphinx as the default execution lib (#1482) * refactor: use nbsphinx as the default execution lib * add nbstripout to the pre-commits' * add pandoc to the readthedocs deps * refactor: clean the notebook * move the example to the correct folder * fix: solve link issue * install pandoc in the test environment * fix: display of large table in executed cells * avoid Userwarnings from matplotlib * hide the matplotlib wrning management cell * Update readthedocs.yml * build: use pandoc_binary to install pandoc * docs: add reference to pandoc in the setup * update docs * remove pypandoc_binary * Update pyproject.toml Co-authored-by: gabalafou <gabriel@fouasnon.com> * ci: use back setup-pandoc * Trigger CI build --------- Co-authored-by: Gabriel Fouasnon <gabriel@fouasnon.com> * BUG - Clear alt_text in conf.py (#1471) * comment out alt_text in conf.py * set alt_text to empty string * remove alt_text from conf.py * fix: use 12rambau fork until it's merged with nikeee repo (#1517) * deps: drop support for Sphinx 5 (#1516) * remove ref to myst-nb * update minimal supported version of sphinx * Fix: (webpack.config.js) css-loader API change (#1508) * Fix: (webpack.config.js) css-loader API change The build was broken in <https://github.com/pydata/pydata-sphinx-theme/commit/185a37aa36820f77bffa4c87a772092e9e7cc380>/<https://github.com/pydata/pydata-sphinx-theme/pull/1494>. This change fixes the build, and it seems to be in accordance with the current API as described at <https://github.com/webpack-contrib/css-loader/blob/c6f36cf91ac61743a70e81cfb077faa0f8730ebe/README.md#boolean>. Closes <https://github.com/pydata/pydata-sphinx-theme/issues/1507>. * dedup * restore version bump --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Fix duplicate HTML IDs (#1425) * Fix duplicate HTML IDs * fix tests * Do not animate the version admonitions colors. (#1424) Otherwise a delay has to be added to the accessibility color contrast checks, to wait for the colors to fully transition. * BUG - Remove redundant ARIA in breadcrumb navigation (#1426) * style(i18n): French Typo fixed (#1430) * Add the ability to add a center section to the footer (#1432) * Add a center section for the footer * Add docs for footer_center * Add a test site for the center footer * test it in our own docs * remove new test site * add footer test --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Build(deps): Bump actions/checkout from 3 to 4 (#1433) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add dropdown_text argument to generate_header_nav_html (#1423) * Add dropdown_text argument to generate_header_nav_html * Add a test, fix typo in theme.conf and remove header_dropdown_text from docs/conf.py * fixed? --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: rollback ref and Id changes (#1438) * bump: version 0.13.3 → 0.14.0 (#1440) * bump version * update version switcher * back to dev * fix: change the z-index of the dropdown (#1442) In order to be on top of the primary sidebar on small screens. * fix: set the same background for dark/light (#1443) * fix: set the same background for dark/light et the same background color for all state of the search field. It is currently only applied when hovered * fix: wrong css selector * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss * Fix duplicate HTML IDs * fix tests * unique_html_id * backwards-compat generate_header_nav_html * feedback review * update fixture * ughhhh...caching * code cleanup * fix test snapshot * put comment inside def --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * chore: build the devcontainer automatically in codespace (#1483) * chore: build the devcontainer automaticallyin codespace * refactor: lint * add pandoc to the environment * Fix font color in search input box (#1524) * Fix color * Use --pst-color-text-base * docs: add DecentralChain (#1528) Co-authored-by: jourlez <josuecr.288@gmail.com> * Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in ru [Manual Sync] (#1527) i18n: Translate sphinx.po in ru [Manual Sync] 96% of minimum 20% translated source file: 'sphinx.po' on 'ru'. Sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * ignore transient errors in windows build CI (#1520) * use warning list * clean up notebook * refactor to pass on all platforms? * simplify * fix logic * iterate backwards * fix plaform detection? also don't log unnecessarily�[H * ignore empty string warnings * remove notebook metawarning * Revert "remove notebook metawarning" This reverts commit 42f46723eb9eeea7603efb91fbfb6bdfa1de28b3. * try again * debug the mysterious empty warning * escape color codes * import * triage by intermittency, not by platform; better var names * simplify * fix list.remove * undo what I broke * Update tests/utils/check_warnings.py * refactor: remove extention on component set-up (#1529) * use event.key for search shortcut (#1525) * use event.key for search shortcut * suggestions from review * caps lock --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> * fix: use a directive instead of raw html * fix: make links externals * fix: set reference in paragraphs * fix: missing parameter * fix: use the stem for the component name * refactor: remove never used variables * standardize component descriptions --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> * fix: primer link in docs (#1556) * docs: add data-content (#1559) Reproduce the change made in Sphinx 7 https://github.com/sphinx-doc/sphinx/commit/8e730ae303ae686705ea12f44ef11da926a87cf5#diff-a5066e933cbf65adc46e0d1ab9a0b44e0a53ca64cc95dca7e6aa902aed6bd468R105 * Obviate background-from-color-variable (#1558) * Obviate background-from-color-variable * backwards compatibility --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * simplify (do not change state of hover) * fix icon links * forgot to add pydata-icon.js * Restore hover styles to sidebar toggles --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * Buttons meet WCAG criteria (#1589) * Match buttons to design system * back to top button * switch to stable version button * remove sd-sphinx-override class which seems to do nothing * underline * center * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss Co-authored-by: Tania Allard <taniar.allard@gmail.com> * don't forget outline buttons --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Up/down chevrons and "expand"/"collapse" for Sphinx-togglebutton (#1605) * Up/down chevrons and "expand"/"collapse" text for Sphinx-togglebutton * Add translation strings * Keyboard handlers to open and close mobile sidebars (#1585) * Consistent focus ring (first pass) (#1549) * wip * Style focus state in header nav * update focus ring style on all focussable elements * simplify * fix links in mobile sidebar overlay * put focus rings around a few more focusable elements * polish * update comment * review * better align focus ring on collapsible admonitions * comment and simplify sphinx-togglebutton focus ring * make css override more explicit * Fix SD link-card focus ring and on homepage, bring links inside card * Update docs/index.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Resolve current sidebar link notch and focus ring (#1561) * Fix sidebar current notch * focus-ring-radius * missed a spot 0.125rem * keep focus ring on top * Restyle Sphinx Design tabs (#1555) * restyle sphinx design tabs * increase panel border radius * increase line height, zero padding-y * use shadow variable * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Fix tabbed panel colors (#1567) * update feature focus (#1569) * docs: add instructions for custom SVG icons (#1490) * docs: add instructions for custom SVG icons * docs: minor tweaks in SVG icon instructions * docs: some more tweaks to SVG icon instructions * Update docs/user_guide/header-links.rst Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * Change literalinclude to code-block in header links * Update docs/user_guide/header-links.rst Co-authored-by: Daniel McCloy <dan@mccloy.info> * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst --------- Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: make table background transparent (#1546) * fix: make table background transparent * fix: make table background transparent * fix: add color-theme option to html tag (#1536) * Silence warnings (#1542) * avoid webpack warning during asset compile * avoid frozen modules warning during import * try to make jupyterlite quieter * add config option to silence warnings * fix tests * add docs * hide conditional warning logic in utils * bump: 0.14.2 → 0.14.3 * chore: back to dev * docs: add the list of component using a directive (#1476) * fix: create the component list automatically * fix: read the first comment as documentation * docs: add disclaimer on .html suffix * docs: document every component with a simple one liner * fix: use regex to identify comments * update component branch (#15) * Change default logo alt text (#1472) * Default logo alt text only if no extra text * change default logo * use docstitle as default logo alt text * update docs to reflect change * Apply suggestions from code review Co-authored-by: Daniel McCloy <dan@mccloy.info> * use string formatting operator * Update docs/user_guide/branding.rst * docs fixes * Update docs/user_guide/branding.rst * add test * Update pyproject.toml * revert to original --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * chore(i18n) catalan (#1488) i18n: Translate sphinx.po in ca 100% translated source file: 'sphinx.po' on 'ca'. Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * Build(deps): Bump postcss and css-loader (#1494) Bumps [postcss](https://github.com/postcss/postcss) to 8.4.31 and updates ancestor dependency [css-loader](https://github.com/webpack-contrib/css-loader). These dependencies need to be updated together. Updates `postcss` from 8.4.21 to 8.4.31 - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/postcss/compare/8.4.21...8.4.31) Updates `css-loader` from 3.6.0 to 6.8.1 - [Release notes](https://github.com/webpack-contrib/css-loader/releases) - [Changelog](https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/css-loader/compare/v3.6.0...v6.8.1) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect - dependency-name: css-loader dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Revert "Build(deps): Bump postcss and css-loader" (#1509) Revert "Build(deps): Bump postcss and css-loader (#1494)" This reverts commit 185a37aa36820f77bffa4c87a772092e9e7cc380. * Update pst docs buttons (#1502) * call them button-links * copy edit * docs: link back to GitHub from PyPI metadata (#1504) This will add a "Source" link in the PyPI page. * navigation_with_keys = False (#1503) * navigation_with_keys = False * None -> False * Apply suggestions from code review --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: convert "stable" to actual version number (#1512) * convert "stable" to actual version number * fix tests re: navigation_with_keys * try bumping autoapi * refactor: use nbsphinx as the default execution lib (#1482) * refactor: use nbsphinx as the default execution lib * add nbstripout to the pre-commits' * add pandoc to the readthedocs deps * refactor: clean the notebook * move the example to the correct folder * fix: solve link issue * install pandoc in the test environment * fix: display of large table in executed cells * avoid Userwarnings from matplotlib * hide the matplotlib wrning management cell * Update readthedocs.yml * build: use pandoc_binary to install pandoc * docs: add reference to pandoc in the setup * update docs * remove pypandoc_binary * Update pyproject.toml Co-authored-by: gabalafou <gabriel@fouasnon.com> * ci: use back setup-pandoc * Trigger CI build --------- Co-authored-by: Gabriel Fouasnon <gabriel@fouasnon.com> * BUG - Clear alt_text in conf.py (#1471) * comment out alt_text in conf.py * set alt_text to empty string * remove alt_text from conf.py * fix: use 12rambau fork until it's merged with nikeee repo (#1517) * deps: drop support for Sphinx 5 (#1516) * remove ref to myst-nb * update minimal supported version of sphinx * Fix: (webpack.config.js) css-loader API change (#1508) * Fix: (webpack.config.js) css-loader API change The build was broken in <https://github.com/pydata/pydata-sphinx-theme/commit/185a37aa36820f77bffa4c87a772092e9e7cc380>/<https://github.com/pydata/pydata-sphinx-theme/pull/1494>. This change fixes the build, and it seems to be in accordance with the current API as described at <https://github.com/webpack-contrib/css-loader/blob/c6f36cf91ac61743a70e81cfb077faa0f8730ebe/README.md#boolean>. Closes <https://github.com/pydata/pydata-sphinx-theme/issues/1507>. * dedup * restore version bump --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Fix duplicate HTML IDs (#1425) * Fix duplicate HTML IDs * fix tests * Do not animate the version admonitions colors. (#1424) Otherwise a delay has to be added to the accessibility color contrast checks, to wait for the colors to fully transition. * BUG - Remove redundant ARIA in breadcrumb navigation (#1426) * style(i18n): French Typo fixed (#1430) * Add the ability to add a center section to the footer (#1432) * Add a center section for the footer * Add docs for footer_center * Add a test site for the center footer * test it in our own docs * remove new test site * add footer test --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Build(deps): Bump actions/checkout from 3 to 4 (#1433) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add dropdown_text argument to generate_header_nav_html (#1423) * Add dropdown_text argument to generate_header_nav_html * Add a test, fix typo in theme.conf and remove header_dropdown_text from docs/conf.py * fixed? --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: rollback ref and Id changes (#1438) * bump: version 0.13.3 → 0.14.0 (#1440) * bump version * update version switcher * back to dev * fix: change the z-index of the dropdown (#1442) In order to be on top of the primary sidebar on small screens. * fix: set the same background for dark/light (#1443) * fix: set the same background for dark/light et the same background color for all state of the search field. It is currently only applied when hovered * fix: wrong css selector * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss * Fix duplicate HTML IDs * fix tests * unique_html_id * backwards-compat generate_header_nav_html * feedback review * update fixture * ughhhh...caching * code cleanup * fix test snapshot * put comment inside def --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * chore: build the devcontainer automatically in codespace (#1483) * chore: build the devcontainer automaticallyin codespace * refactor: lint * add pandoc to the environment * Fix font color in search input box (#1524) * Fix color * Use --pst-color-text-base * docs: add DecentralChain (#1528) Co-authored-by: jourlez <josuecr.288@gmail.com> * Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in ru [Manual Sync] (#1527) i18n: Translate sphinx.po in ru [Manual Sync] 96% of minimum 20% translated source file: 'sphinx.po' on 'ru'. Sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * ignore transient errors in windows build CI (#1520) * use warning list * clean up notebook * refactor to pass on all platforms? * simplify * fix logic * iterate backwards * fix plaform detection? also don't log unnecessarily�[H * ignore empty string warnings * remove notebook metawarning * Revert "remove notebook metawarning" This reverts commit 42f46723eb9eeea7603efb91fbfb6bdfa1de28b3. * try again * debug the mysterious empty warning * escape color codes * import * triage by intermittency, not by platform; better var names * simplify * fix list.remove * undo what I broke * Update tests/utils/check_warnings.py * refactor: remove extention on component set-up (#1529) * use event.key for search shortcut (#1525) * use event.key for search shortcut * suggestions from review * caps lock --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> * fix: use a directive instead of raw html * fix: make links externals * fix: set reference in paragraphs * fix: missing parameter * fix: use the stem for the component name * refactor: remove never used variables * standardize component descriptions --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> * fix: primer link in docs (#1556) * docs: add data-content (#1559) Reproduce the change made in Sphinx 7 https://github.com/sphinx-doc/sphinx/commit/8e730ae303ae686705ea12f44ef11da926a87cf5#diff-a5066e933cbf65adc46e0d1ab9a0b44e0a53ca64cc95dca7e6aa902aed6bd468R105 * Obviate background-from-color-variable (#1558) * Obviate background-from-color-variable * backwards compatibility --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * Keyboard handlers to open and close mobile sidebars * Update src/pydata_sphinx_theme/__init__.py --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * Merge main into feature-focus (#1685) * Build(deps): Bump actions/setup-python from 4 to 5 (#1590) Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Use pytest-regressions to mark expected a11y test failures (#1501) * Use pytest-regressions with a11y tests to mark expected failures * Update tests/test_a11y.py * frozen data class * Revert "frozen data class" This reverts commit 3b0c73e93d1f1b52f45b4918015c66fe5142c294. --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * FIX: avoid implicit string comparison in Sphinx 7.26 (#1592) * FIX: avoid implicit string comparison in Sphinx 7.26 * lint --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Build(deps): Bump actions/upload-artifact from 3 to 4 (#1598) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update fontawesome from 6.1.2 to 6.5.1 (#1600) * Fix landmark-unique error due to in-page TOC (#1607) * landmark unique error due to in-page TOC * Apply suggestions from code review Co-authored-by: Tania Allard <taniar.allard@gmail.com> * fix lint? --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Feature: Add support for per-page secondary sidebar content (#1572) * Add ability to set per-page secondary sidebars * Add additional secondary sidebar content tests; expanded utils docstring * Update translation files (#1606) * Bump minimum Python from 3.8 to 3.9; add 3.12 to CIs (#1610) drop py3.8, add py3.12 * Fix: more efficient determination of when to hide primary sidebar (#1609) * minor refactors suggested by Ruff * move TOC generation from layout.html to sidebar-primary.html * replace @lru_cache(None) with plain @cache * get sidebar TOC length without rendering it * fixup rebase/stash snafu * bugfix * Fix "More" links in mobile sidebar (#1604) Fix #1603 * bump: 0.14.4 → 0.15.0rc0 * Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in fr (#1618) i18n: Translate sphinx.po in fr 100% translated source file: 'sphinx.po' on 'fr'. Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * bump: 0.14.4 → 0.15.0 * fix: drop the dev test (#1623) * fix: remove Site navigation header (#1615) * fix: remove Site navigation header * test: edit the test suit * fix: align all breadcrumb elements (#1619) * fix: log information when warnings are disabled (#1617) * bump: 0.15.0 → 0.15.1 * back to dev * fix: align the search button with other icons (#1620) * test: display the search button for demo purposes * fix: only display the search icon * fix: remove needless adjustements * fix: rollback to default search * chore: trigger CI * Fix sticky header (#1630) * Fix sticky header * regression test * maybe fix missing sidebar? (#1632) * maybe fix missing sidebar? * simplify * purge internal defaults & use theme config setting * formatting * refactor and simplify toctree code * DOC: Add missing "footer_center" in layout overview diagram (#1640) * Make bootstrap globally available (#1639) * Make bootstrap globally available * Include docs about bootstrap programmatic API * Add Brightway to Featured Example Gallery Grid (#1580) * initial commit * test: the png images are not build during tests --------- Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * fix: move the release instructions to the repository (#1621) * fix: update text and links * fix: add code highlight * fix: wire correct file in our documentation * chore: trigger CI * remove mention of semantic versioning Co-authored-by: Daniel McCloy <dan@mccloy.info> * refactor: lint * Update RELEASE.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Make search event listener only trigger with “K”/“k” (#1646) * More speedups to section TOC rendering (#1642) * small refactor, comments, cleanup * docstring cleanups * mark as unsafe for parallel write * Update src/pydata_sphinx_theme/toctree.py * Allow only theme_footer_center to be set (#1653) * fix: allow user to control the back-to-top button presence (#1616) * fix: put the btt button closer to age bottom * test: remove the btt button to check * test: fallback to default behaviour * refactor: rollback to previous state * use proper variable name * Update src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * remove toggle button for secondary sidebar if empty (#1637) * in CIs, pin sphinx dev temporarily * bump: 0.15.1 -> 0.15.2 * bump version to dev * FIX make theme switcher have consistent widths (#1651) * unpin sphinx in CI (#1665) * FIX make search button closer to other icons in topbar (#1659) * Build(deps): Bump actions/cache from 3 to 4 (#1667) Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](https://github.com/actions/cache/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * update dependabot labels (#1668) * only do security updates for NPM (#1674) * Restore search snippet highlights in search results page (#1678) * Apply default_mode to the html data-theme attribute (#1663) * Don't try to populate version switcher w/ relative path on local static site (#1660) * Don't try to populate version switcher on static sites * Fix comment spelling * Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * handle null result from queryselector (#1683) fix queryselector * Add pst-header-nav-item id to fix tests --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Angus Hollands <goosey15@gmail.com> Co-authored-by: Sebastiaan Huber <mail@sphuber.net> Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Peyton Murray <peynmurray@gmail.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Michael Wisely <108433848+michael-wisely-gravwell@users.noreply.github.com> Co-authored-by: Michael Weinold <23102087+michaelweinold@users.noreply.github.com> Co-authored-by: Philipp A <flying-sheep@web.de> Co-authored-by: Colin Marquardt <cmarqu42@gmail.com> Co-authored-by: Pierre Marchand <PierreMarchand20@users.noreply.github.com> Co-authored-by: Yao Xiao <108576690+Charlie-XIAO@users.noreply.github.com> Co-authored-by: Charles <peacech@gmail.com> Co-authored-by: David Stansby <dstansby@gmail.com> * Merge main into feature-focus (#1708) * Build(deps): Bump actions/setup-python from 4 to 5 (#1590) Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Use pytest-regressions to mark expected a11y test failures (#1501) * Use pytest-regressions with a11y tests to mark expected failures * Update tests/test_a11y.py * frozen data class * Revert "frozen data class" This reverts commit 3b0c73e93d1f1b52f45b4918015c66fe5142c294. --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * FIX: avoid implicit string comparison in Sphinx 7.26 (#1592) * FIX: avoid implicit string comparison in Sphinx 7.26 * lint --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Build(deps): Bump actions/upload-artifact from 3 to 4 (#1598) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update fontawesome from 6.1.2 to 6.5.1 (#1600) * Fix landmark-unique error due to in-page TOC (#1607) * landmark unique error due to in-page TOC * Apply suggestions from code review Co-authored-by: Tania Allard <taniar.allard@gmail.com> * fix lint? --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Feature: Add support for per-page secondary sidebar content (#1572) * Add ability to set per-page secondary sidebars * Add additional secondary sidebar content tests; expanded utils docstring * Update translation files (#1606) * Bump minimum Python from 3.8 to 3.9; add 3.12 to CIs (#1610) drop py3.8, add py3.12 * Fix: more efficient determination of when to hide primary sidebar (#1609) * minor refactors suggested by Ruff * move TOC generation from layout.html to sidebar-primary.html * replace @lru_cache(None) with plain @cache * get sidebar TOC length without rendering it * fixup rebase/stash snafu * bugfix * Fix "More" links in mobile sidebar (#1604) Fix #1603 * bump: 0.14.4 → 0.15.0rc0 * Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in fr (#1618) i18n: Translate sphinx.po in fr 100% translated source file: 'sphinx.po' on 'fr'. Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * bump: 0.14.4 → 0.15.0 * fix: drop the dev test (#1623) * fix: remove Site navigation header (#1615) * fix: remove Site navigation header * test: edit the test suit * fix: align all breadcrumb elements (#1619) * fix: log information when warnings are disabled (#1617) * bump: 0.15.0 → 0.15.1 * back to dev * fix: align the search button with other icons (#1620) * test: display the search button for demo purposes * fix: only display the search icon * fix: remove needless adjustements * fix: rollback to default search * chore: trigger CI * Fix sticky header (#1630) * Fix sticky header * regression test * maybe fix missing sidebar? (#1632) * maybe fix missing sidebar? * simplify * purge internal defaults & use theme config setting * formatting * refactor and simplify toctree code * DOC: Add missing "footer_center" in layout overview diagram (#1640) * Make bootstrap globally available (#1639) * Make bootstrap globally available * Include docs about bootstrap programmatic API * Add Brightway to Featured Example Gallery Grid (#1580) * initial commit * test: the png images are not build during tests --------- Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * fix: move the release instructions to the repository (#1621) * fix: update text and links * fix: add code highlight * fix: wire correct file in our documentation * chore: trigger CI * remove mention of semantic versioning Co-authored-by: Daniel McCloy <dan@mccloy.info> * refactor: lint * Update RELEASE.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Make search event listener only trigger with “K”/“k” (#1646) * More speedups to section TOC rendering (#1642) * small refactor, comments, cleanup * docstring cleanups * mark as unsafe for parallel write * Update src/pydata_sphinx_theme/toctree.py * Allow only theme_footer_center to be set (#1653) * fix: allow user to control the back-to-top button presence (#1616) * fix: put the btt button closer to age bottom * test: remove the btt button to check * test: fallback to default behaviour * refactor: rollback to previous state * use proper variable name * Update src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * remove toggle button for secondary sidebar if empty (#1637) * in CIs, pin sphinx dev temporarily * bump: 0.15.1 -> 0.15.2 * bump version to dev * FIX make theme switcher have consistent widths (#1651) * unpin sphinx in CI (#1665) * FIX make search button closer to other icons in topbar (#1659) * Build(deps): Bump actions/cache from 3 to 4 (#1667) Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](https://github.com/actions/cache/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * update dependabot labels (#1668) * only do security updates for NPM (#1674) * Restore search snippet highlights in search results page (#1678) * Apply default_mode to the html data-theme attribute (#1663) * Don't try to populate version switcher w/ relative path on local static site (#1660) * Don't try to populate version switcher on static sites * Fix comment spelling * Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * handle null result from queryselector (#1683) fix queryselector * ENH make search result heading a bit away from the search input box (#1690) ENH make search result heading a bit away from the search box * ENH animation for the top banner (#1693) * ENH animation for the top banner * unset forcefully set styles to let css take over; animation also added for version warning banner * make transition a bit longer * resolve conversations * retrigger CI * Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * docs: typo in a link in the release instructions (#1704) * Build(deps): Bump codecov/codecov-action from 3 to 4 (#1706) Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 3 to 4. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/codecov/codecov-action/compare/v3...v4) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Build(deps): Bump treosh/lighthouse-ci-action from 10 to 11 (#1705) Bumps [treosh/lighthouse-ci-action](https://github.com/treosh/lighthouse-ci-action) from 10 to 11. - [Release notes](https://github.com/treosh/lighthouse-ci-action/releases) - [Commits](https://github.com/treosh/lighthouse-ci-action/compare/v10...v11) --- updated-dependencies: - dependency-name: treosh/lighthouse-ci-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Angus Hollands <goosey15@gmail.com> Co-authored-by: Sebastiaan Huber <mail@sphuber.net> Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Peyton Murray <peynmurray@gmail.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Michael Wisely <108433848+michael-wisely-gravwell@users.noreply.github.com> Co-authored-by: Michael Weinold <23102087+michaelweinold@users.noreply.github.com> Co-authored-by: Philipp A <flying-sheep@web.de> Co-authored-by: Colin Marquardt <cmarqu42@gmail.com> Co-authored-by: Pierre Marchand <PierreMarchand20@users.noreply.github.com> Co-authored-by: Yao Xiao <108576690+Charlie-XIAO@users.noreply.github.com> Co-authored-by: Charles <peacech@gmail.com> Co-authored-by: David Stansby <dstansby@gmail.com> * Make TOC sections expandable and collapsible by keyboard (#1582) * Consistent focus ring (first pass) (#1549) * wip * Style focus state in header nav * update focus ring style on all focussable elements * simplify * fix links in mobile sidebar overlay * put focus rings around a few more focusable elements * polish * update comment * review * better align focus ring on collapsible admonitions * comment and simplify sphinx-togglebutton focus ring * make css override more explicit * Fix SD link-card focus ring and on homepage, bring links inside card * Update docs/index.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Resolve current sidebar link notch and focus ring (#1561) * Fix sidebar current notch * focus-ring-radius * missed a spot 0.125rem * keep focus ring on top * Restyle Sphinx Design tabs (#1555) * restyle sphinx design tabs * increase panel border radius * increase line height, zero padding-y * use shadow variable * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Fix tabbed panel colors (#1567) * aria attributes do not update if user uses mouse instead of keyboard * details/summary, no checkbox * clean up * details["open"] * make it work for nav level 0 * pull link outside of details tag * make it work with show nav level 0 * make level 0 heading clickable * comments * restore .current notches to toc parents * fix tests * clean up * more comments * make toggle icon bigger at level 0 * comments * clarify comment * remove list-captions class from in-page toc styles * Update tests/test_build.py * Update src/pydata_sphinx_theme/toctree.py Co-authored-by: Tania Allard <taniar.allard@gmail.com> * update test for verbose HTML boolean attribute * more HTML boolean attribute notation updates * Update comment about link vs non-link HTML structure --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Independently style "Switch to stable version" link (#1721) * Independently style switch to stable version link * hover and focus * docs and css cleanup * Use focus ring Sass variables * text-wrap class * Update docs/user_guide/web-components.rst Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Update docs/user_guide/web-components.rst Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Update src/pydata_sphinx_theme/assets/styles/sections/_announcement.scss Co-authored-by: Tania Allard <taniar.allard@gmail.com> * use var --pst-color-danger-text --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Ensure old test files are removed * Run pre-commit * Add to the accessibility support section of the docs (#1730) * add entry to the docs * Apply suggestions from code review Co-authored-by: Daniel McCloy <dan@mccloy.info> --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> * Feature focus review fixes (#1736) * fix search bar hover * fix overlapping focus and hover rings on More dropdown toggle * point chevron up * fix translations * conf.py fixes * Revert changes to horizontal spacing in header nav (#1738) * revert changes to horizontal spacing in header nav * keep outline offset at 3px * set Codecov verbose flag to true (#1743) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> Co-authored-by: Angus Hollands <goosey15@gmail.com> Co-authored-by: Sebastiaan Huber <mail@sphuber.net> Co-authored-by: Peyton Murray <peynmurray@gmail.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Michael Wisely <108433848+michael-wisely-gravwell@users.noreply.github.com> Co-authored-by: Michael Weinold <23102087+michaelweinold@users.noreply.github.com> Co-authored-by: Philipp A <flying-sheep@web.de> Co-authored-by: Colin Marquardt <cmarqu42@gmail.com> Co-authored-by: Pierre Marchand <PierreMarchand20@users.noreply.github.com> Co-authored-by: Yao Xiao <108576690+Charlie-XIAO@users.noreply.github.com> Co-authored-by: Charles <peacech@gmail.com> Co-authored-by: David Stansby <dstansby@gmail.com>
gabalafou
added a commit
to gabalafou/pydata-sphinx-theme
that referenced
this pull request
Apr 29, 2024
* Consistent focus ring (first pass) (#1549) * wip * Style focus state in header nav * update focus ring style on all focussable elements * simplify * fix links in mobile sidebar overlay * put focus rings around a few more focusable elements * polish * update comment * review * better align focus ring on collapsible admonitions * comment and simplify sphinx-togglebutton focus ring * make css override more explicit * Fix SD link-card focus ring and on homepage, bring links inside card * Update docs/index.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Resolve current sidebar link notch and focus ring (#1561) * Fix sidebar current notch * focus-ring-radius * missed a spot 0.125rem * keep focus ring on top * Restyle Sphinx Design tabs (#1555) * restyle sphinx design tabs * increase panel border radius * increase line height, zero padding-y * use shadow variable * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Fix tabbed panel colors (#1567) * Header nav link styles (focus, hover, current) (#1545) * Implement header nav link styles * add comments * add comment * changes from implementation review * Consistent focus ring (first pass) (#1549) * wip * Style focus state in header nav * update focus ring style on all focussable elements * simplify * fix links in mobile sidebar overlay * put focus rings around a few more focusable elements * polish * update comment * review * better align focus ring on collapsible admonitions * comment and simplify sphinx-togglebutton focus ring * make css override more explicit * Fix SD link-card focus ring and on homepage, bring links inside card * Update docs/index.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Resolve current sidebar link notch and focus ring (#1561) * Fix sidebar current notch * focus-ring-radius * missed a spot 0.125rem * keep focus ring on top * Restyle Sphinx Design tabs (#1555) * restyle sphinx design tabs * increase panel border radius * increase line height, zero padding-y * use shadow variable * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Fix tabbed panel colors (#1567) * update feature focus (#1569) * docs: add instructions for custom SVG icons (#1490) * docs: add instructions for custom SVG icons * docs: minor tweaks in SVG icon instructions * docs: some more tweaks to SVG icon instructions * Update docs/user_guide/header-links.rst Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * Change literalinclude to code-block in header links * Update docs/user_guide/header-links.rst Co-authored-by: Daniel McCloy <dan@mccloy.info> * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst --------- Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: make table background transparent (#1546) * fix: make table background transparent * fix: make table background transparent * fix: add color-theme option to html tag (#1536) * Silence warnings (#1542) * avoid webpack warning during asset compile * avoid frozen modules warning during import * try to make jupyterlite quieter * add config option to silence warnings * fix tests * add docs * hide conditional warning logic in utils * bump: 0.14.2 → 0.14.3 * chore: back to dev * docs: add the list of component using a directive (#1476) * fix: create the component list automatically * fix: read the first comment as documentation * docs: add disclaimer on .html suffix * docs: document every component with a simple one liner * fix: use regex to identify comments * update component branch (#15) * Change default logo alt text (#1472) * Default logo alt text only if no extra text * change default logo * use docstitle as default logo alt text * update docs to reflect change * Apply suggestions from code review Co-authored-by: Daniel McCloy <dan@mccloy.info> * use string formatting operator * Update docs/user_guide/branding.rst * docs fixes * Update docs/user_guide/branding.rst * add test * Update pyproject.toml * revert to original --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * chore(i18n) catalan (#1488) i18n: Translate sphinx.po in ca 100% translated source file: 'sphinx.po' on 'ca'. Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * Build(deps): Bump postcss and css-loader (#1494) Bumps [postcss](https://github.com/postcss/postcss) to 8.4.31 and updates ancestor dependency [css-loader](https://github.com/webpack-contrib/css-loader). These dependencies need to be updated together. Updates `postcss` from 8.4.21 to 8.4.31 - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/postcss/compare/8.4.21...8.4.31) Updates `css-loader` from 3.6.0 to 6.8.1 - [Release notes](https://github.com/webpack-contrib/css-loader/releases) - [Changelog](https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/css-loader/compare/v3.6.0...v6.8.1) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect - dependency-name: css-loader dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Revert "Build(deps): Bump postcss and css-loader" (#1509) Revert "Build(deps): Bump postcss and css-loader (#1494)" This reverts commit 185a37aa36820f77bffa4c87a772092e9e7cc380. * Update pst docs buttons (#1502) * call them button-links * copy edit * docs: link back to GitHub from PyPI metadata (#1504) This will add a "Source" link in the PyPI page. * navigation_with_keys = False (#1503) * navigation_with_keys = False * None -> False * Apply suggestions from code review --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: convert "stable" to actual version number (#1512) * convert "stable" to actual version number * fix tests re: navigation_with_keys * try bumping autoapi * refactor: use nbsphinx as the default execution lib (#1482) * refactor: use nbsphinx as the default execution lib * add nbstripout to the pre-commits' * add pandoc to the readthedocs deps * refactor: clean the notebook * move the example to the correct folder * fix: solve link issue * install pandoc in the test environment * fix: display of large table in executed cells * avoid Userwarnings from matplotlib * hide the matplotlib wrning management cell * Update readthedocs.yml * build: use pandoc_binary to install pandoc * docs: add reference to pandoc in the setup * update docs * remove pypandoc_binary * Update pyproject.toml Co-authored-by: gabalafou <gabriel@fouasnon.com> * ci: use back setup-pandoc * Trigger CI build --------- Co-authored-by: Gabriel Fouasnon <gabriel@fouasnon.com> * BUG - Clear alt_text in conf.py (#1471) * comment out alt_text in conf.py * set alt_text to empty string * remove alt_text from conf.py * fix: use 12rambau fork until it's merged with nikeee repo (#1517) * deps: drop support for Sphinx 5 (#1516) * remove ref to myst-nb * update minimal supported version of sphinx * Fix: (webpack.config.js) css-loader API change (#1508) * Fix: (webpack.config.js) css-loader API change The build was broken in <https://github.com/pydata/pydata-sphinx-theme/commit/185a37aa36820f77bffa4c87a772092e9e7cc380>/<https://github.com/pydata/pydata-sphinx-theme/pull/1494>. This change fixes the build, and it seems to be in accordance with the current API as described at <https://github.com/webpack-contrib/css-loader/blob/c6f36cf91ac61743a70e81cfb077faa0f8730ebe/README.md#boolean>. Closes <https://github.com/pydata/pydata-sphinx-theme/issues/1507>. * dedup * restore version bump --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Fix duplicate HTML IDs (#1425) * Fix duplicate HTML IDs * fix tests * Do not animate the version admonitions colors. (#1424) Otherwise a delay has to be added to the accessibility color contrast checks, to wait for the colors to fully transition. * BUG - Remove redundant ARIA in breadcrumb navigation (#1426) * style(i18n): French Typo fixed (#1430) * Add the ability to add a center section to the footer (#1432) * Add a center section for the footer * Add docs for footer_center * Add a test site for the center footer * test it in our own docs * remove new test site * add footer test --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Build(deps): Bump actions/checkout from 3 to 4 (#1433) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add dropdown_text argument to generate_header_nav_html (#1423) * Add dropdown_text argument to generate_header_nav_html * Add a test, fix typo in theme.conf and remove header_dropdown_text from docs/conf.py * fixed? --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: rollback ref and Id changes (#1438) * bump: version 0.13.3 → 0.14.0 (#1440) * bump version * update version switcher * back to dev * fix: change the z-index of the dropdown (#1442) In order to be on top of the primary sidebar on small screens. * fix: set the same background for dark/light (#1443) * fix: set the same background for dark/light et the same background color for all state of the search field. It is currently only applied when hovered * fix: wrong css selector * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss * Fix duplicate HTML IDs * fix tests * unique_html_id * backwards-compat generate_header_nav_html * feedback review * update fixture * ughhhh...caching * code cleanup * fix test snapshot * put comment inside def --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * chore: build the devcontainer automatically in codespace (#1483) * chore: build the devcontainer automaticallyin codespace * refactor: lint * add pandoc to the environment * Fix font color in search input box (#1524) * Fix color * Use --pst-color-text-base * docs: add DecentralChain (#1528) Co-authored-by: jourlez <josuecr.288@gmail.com> * Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in ru [Manual Sync] (#1527) i18n: Translate sphinx.po in ru [Manual Sync] 96% of minimum 20% translated source file: 'sphinx.po' on 'ru'. Sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * ignore transient errors in windows build CI (#1520) * use warning list * clean up notebook * refactor to pass on all platforms? * simplify * fix logic * iterate backwards * fix plaform detection? also don't log unnecessarily�[H * ignore empty string warnings * remove notebook metawarning * Revert "remove notebook metawarning" This reverts commit 42f46723eb9eeea7603efb91fbfb6bdfa1de28b3. * try again * debug the mysterious empty warning * escape color codes * import * triage by intermittency, not by platform; better var names * simplify * fix list.remove * undo what I broke * Update tests/utils/check_warnings.py * refactor: remove extention on component set-up (#1529) * use event.key for search shortcut (#1525) * use event.key for search shortcut * suggestions from review * caps lock --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> * fix: use a directive instead of raw html * fix: make links externals * fix: set reference in paragraphs * fix: missing parameter * fix: use the stem for the component name * refactor: remove never used variables * standardize component descriptions --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> * fix: primer link in docs (#1556) * docs: add data-content (#1559) Reproduce the change made in Sphinx 7 https://github.com/sphinx-doc/sphinx/commit/8e730ae303ae686705ea12f44ef11da926a87cf5#diff-a5066e933cbf65adc46e0d1ab9a0b44e0a53ca64cc95dca7e6aa902aed6bd468R105 * Obviate background-from-color-variable (#1558) * Obviate background-from-color-variable * backwards compatibility --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * simplify (do not change state of hover) * fix icon links * forgot to add pydata-icon.js * Restore hover styles to sidebar toggles --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * Buttons meet WCAG criteria (#1589) * Match buttons to design system * back to top button * switch to stable version button * remove sd-sphinx-override class which seems to do nothing * underline * center * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss Co-authored-by: Tania Allard <taniar.allard@gmail.com> * don't forget outline buttons --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Up/down chevrons and "expand"/"collapse" for Sphinx-togglebutton (#1605) * Up/down chevrons and "expand"/"collapse" text for Sphinx-togglebutton * Add translation strings * Keyboard handlers to open and close mobile sidebars (#1585) * Consistent focus ring (first pass) (#1549) * wip * Style focus state in header nav * update focus ring style on all focussable elements * simplify * fix links in mobile sidebar overlay * put focus rings around a few more focusable elements * polish * update comment * review * better align focus ring on collapsible admonitions * comment and simplify sphinx-togglebutton focus ring * make css override more explicit * Fix SD link-card focus ring and on homepage, bring links inside card * Update docs/index.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Resolve current sidebar link notch and focus ring (#1561) * Fix sidebar current notch * focus-ring-radius * missed a spot 0.125rem * keep focus ring on top * Restyle Sphinx Design tabs (#1555) * restyle sphinx design tabs * increase panel border radius * increase line height, zero padding-y * use shadow variable * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Fix tabbed panel colors (#1567) * update feature focus (#1569) * docs: add instructions for custom SVG icons (#1490) * docs: add instructions for custom SVG icons * docs: minor tweaks in SVG icon instructions * docs: some more tweaks to SVG icon instructions * Update docs/user_guide/header-links.rst Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * Change literalinclude to code-block in header links * Update docs/user_guide/header-links.rst Co-authored-by: Daniel McCloy <dan@mccloy.info> * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst * Update docs/user_guide/header-links.rst --------- Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: make table background transparent (#1546) * fix: make table background transparent * fix: make table background transparent * fix: add color-theme option to html tag (#1536) * Silence warnings (#1542) * avoid webpack warning during asset compile * avoid frozen modules warning during import * try to make jupyterlite quieter * add config option to silence warnings * fix tests * add docs * hide conditional warning logic in utils * bump: 0.14.2 → 0.14.3 * chore: back to dev * docs: add the list of component using a directive (#1476) * fix: create the component list automatically * fix: read the first comment as documentation * docs: add disclaimer on .html suffix * docs: document every component with a simple one liner * fix: use regex to identify comments * update component branch (#15) * Change default logo alt text (#1472) * Default logo alt text only if no extra text * change default logo * use docstitle as default logo alt text * update docs to reflect change * Apply suggestions from code review Co-authored-by: Daniel McCloy <dan@mccloy.info> * use string formatting operator * Update docs/user_guide/branding.rst * docs fixes * Update docs/user_guide/branding.rst * add test * Update pyproject.toml * revert to original --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * chore(i18n) catalan (#1488) i18n: Translate sphinx.po in ca 100% translated source file: 'sphinx.po' on 'ca'. Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * Build(deps): Bump postcss and css-loader (#1494) Bumps [postcss](https://github.com/postcss/postcss) to 8.4.31 and updates ancestor dependency [css-loader](https://github.com/webpack-contrib/css-loader). These dependencies need to be updated together. Updates `postcss` from 8.4.21 to 8.4.31 - [Release notes](https://github.com/postcss/postcss/releases) - [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md) - [Commits](https://github.com/postcss/postcss/compare/8.4.21...8.4.31) Updates `css-loader` from 3.6.0 to 6.8.1 - [Release notes](https://github.com/webpack-contrib/css-loader/releases) - [Changelog](https://github.com/webpack-contrib/css-loader/blob/master/CHANGELOG.md) - [Commits](https://github.com/webpack-contrib/css-loader/compare/v3.6.0...v6.8.1) --- updated-dependencies: - dependency-name: postcss dependency-type: indirect - dependency-name: css-loader dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Revert "Build(deps): Bump postcss and css-loader" (#1509) Revert "Build(deps): Bump postcss and css-loader (#1494)" This reverts commit 185a37aa36820f77bffa4c87a772092e9e7cc380. * Update pst docs buttons (#1502) * call them button-links * copy edit * docs: link back to GitHub from PyPI metadata (#1504) This will add a "Source" link in the PyPI page. * navigation_with_keys = False (#1503) * navigation_with_keys = False * None -> False * Apply suggestions from code review --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: convert "stable" to actual version number (#1512) * convert "stable" to actual version number * fix tests re: navigation_with_keys * try bumping autoapi * refactor: use nbsphinx as the default execution lib (#1482) * refactor: use nbsphinx as the default execution lib * add nbstripout to the pre-commits' * add pandoc to the readthedocs deps * refactor: clean the notebook * move the example to the correct folder * fix: solve link issue * install pandoc in the test environment * fix: display of large table in executed cells * avoid Userwarnings from matplotlib * hide the matplotlib wrning management cell * Update readthedocs.yml * build: use pandoc_binary to install pandoc * docs: add reference to pandoc in the setup * update docs * remove pypandoc_binary * Update pyproject.toml Co-authored-by: gabalafou <gabriel@fouasnon.com> * ci: use back setup-pandoc * Trigger CI build --------- Co-authored-by: Gabriel Fouasnon <gabriel@fouasnon.com> * BUG - Clear alt_text in conf.py (#1471) * comment out alt_text in conf.py * set alt_text to empty string * remove alt_text from conf.py * fix: use 12rambau fork until it's merged with nikeee repo (#1517) * deps: drop support for Sphinx 5 (#1516) * remove ref to myst-nb * update minimal supported version of sphinx * Fix: (webpack.config.js) css-loader API change (#1508) * Fix: (webpack.config.js) css-loader API change The build was broken in <https://github.com/pydata/pydata-sphinx-theme/commit/185a37aa36820f77bffa4c87a772092e9e7cc380>/<https://github.com/pydata/pydata-sphinx-theme/pull/1494>. This change fixes the build, and it seems to be in accordance with the current API as described at <https://github.com/webpack-contrib/css-loader/blob/c6f36cf91ac61743a70e81cfb077faa0f8730ebe/README.md#boolean>. Closes <https://github.com/pydata/pydata-sphinx-theme/issues/1507>. * dedup * restore version bump --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Fix duplicate HTML IDs (#1425) * Fix duplicate HTML IDs * fix tests * Do not animate the version admonitions colors. (#1424) Otherwise a delay has to be added to the accessibility color contrast checks, to wait for the colors to fully transition. * BUG - Remove redundant ARIA in breadcrumb navigation (#1426) * style(i18n): French Typo fixed (#1430) * Add the ability to add a center section to the footer (#1432) * Add a center section for the footer * Add docs for footer_center * Add a test site for the center footer * test it in our own docs * remove new test site * add footer test --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Build(deps): Bump actions/checkout from 3 to 4 (#1433) Bumps [actions/checkout](https://github.com/actions/checkout) from 3 to 4. - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Add dropdown_text argument to generate_header_nav_html (#1423) * Add dropdown_text argument to generate_header_nav_html * Add a test, fix typo in theme.conf and remove header_dropdown_text from docs/conf.py * fixed? --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * fix: rollback ref and Id changes (#1438) * bump: version 0.13.3 → 0.14.0 (#1440) * bump version * update version switcher * back to dev * fix: change the z-index of the dropdown (#1442) In order to be on top of the primary sidebar on small screens. * fix: set the same background for dark/light (#1443) * fix: set the same background for dark/light et the same background color for all state of the search field. It is currently only applied when hovered * fix: wrong css selector * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss * Update src/pydata_sphinx_theme/assets/styles/components/_search.scss * Fix duplicate HTML IDs * fix tests * unique_html_id * backwards-compat generate_header_nav_html * feedback review * update fixture * ughhhh...caching * code cleanup * fix test snapshot * put comment inside def --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * chore: build the devcontainer automatically in codespace (#1483) * chore: build the devcontainer automaticallyin codespace * refactor: lint * add pandoc to the environment * Fix font color in search input box (#1524) * Fix color * Use --pst-color-text-base * docs: add DecentralChain (#1528) Co-authored-by: jourlez <josuecr.288@gmail.com> * Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in ru [Manual Sync] (#1527) i18n: Translate sphinx.po in ru [Manual Sync] 96% of minimum 20% translated source file: 'sphinx.po' on 'ru'. Sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * ignore transient errors in windows build CI (#1520) * use warning list * clean up notebook * refactor to pass on all platforms? * simplify * fix logic * iterate backwards * fix plaform detection? also don't log unnecessarily�[H * ignore empty string warnings * remove notebook metawarning * Revert "remove notebook metawarning" This reverts commit 42f46723eb9eeea7603efb91fbfb6bdfa1de28b3. * try again * debug the mysterious empty warning * escape color codes * import * triage by intermittency, not by platform; better var names * simplify * fix list.remove * undo what I broke * Update tests/utils/check_warnings.py * refactor: remove extention on component set-up (#1529) * use event.key for search shortcut (#1525) * use event.key for search shortcut * suggestions from review * caps lock --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> * fix: use a directive instead of raw html * fix: make links externals * fix: set reference in paragraphs * fix: missing parameter * fix: use the stem for the component name * refactor: remove never used variables * standardize component descriptions --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> * fix: primer link in docs (#1556) * docs: add data-content (#1559) Reproduce the change made in Sphinx 7 https://github.com/sphinx-doc/sphinx/commit/8e730ae303ae686705ea12f44ef11da926a87cf5#diff-a5066e933cbf65adc46e0d1ab9a0b44e0a53ca64cc95dca7e6aa902aed6bd468R105 * Obviate background-from-color-variable (#1558) * Obviate background-from-color-variable * backwards compatibility --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * Keyboard handlers to open and close mobile sidebars * Update src/pydata_sphinx_theme/__init__.py --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> * Merge main into feature-focus (#1685) * Build(deps): Bump actions/setup-python from 4 to 5 (#1590) Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Use pytest-regressions to mark expected a11y test failures (#1501) * Use pytest-regressions with a11y tests to mark expected failures * Update tests/test_a11y.py * frozen data class * Revert "frozen data class" This reverts commit 3b0c73e93d1f1b52f45b4918015c66fe5142c294. --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * FIX: avoid implicit string comparison in Sphinx 7.26 (#1592) * FIX: avoid implicit string comparison in Sphinx 7.26 * lint --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Build(deps): Bump actions/upload-artifact from 3 to 4 (#1598) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update fontawesome from 6.1.2 to 6.5.1 (#1600) * Fix landmark-unique error due to in-page TOC (#1607) * landmark unique error due to in-page TOC * Apply suggestions from code review Co-authored-by: Tania Allard <taniar.allard@gmail.com> * fix lint? --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Feature: Add support for per-page secondary sidebar content (#1572) * Add ability to set per-page secondary sidebars * Add additional secondary sidebar content tests; expanded utils docstring * Update translation files (#1606) * Bump minimum Python from 3.8 to 3.9; add 3.12 to CIs (#1610) drop py3.8, add py3.12 * Fix: more efficient determination of when to hide primary sidebar (#1609) * minor refactors suggested by Ruff * move TOC generation from layout.html to sidebar-primary.html * replace @lru_cache(None) with plain @cache * get sidebar TOC length without rendering it * fixup rebase/stash snafu * bugfix * Fix "More" links in mobile sidebar (#1604) Fix #1603 * bump: 0.14.4 → 0.15.0rc0 * Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in fr (#1618) i18n: Translate sphinx.po in fr 100% translated source file: 'sphinx.po' on 'fr'. Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * bump: 0.14.4 → 0.15.0 * fix: drop the dev test (#1623) * fix: remove Site navigation header (#1615) * fix: remove Site navigation header * test: edit the test suit * fix: align all breadcrumb elements (#1619) * fix: log information when warnings are disabled (#1617) * bump: 0.15.0 → 0.15.1 * back to dev * fix: align the search button with other icons (#1620) * test: display the search button for demo purposes * fix: only display the search icon * fix: remove needless adjustements * fix: rollback to default search * chore: trigger CI * Fix sticky header (#1630) * Fix sticky header * regression test * maybe fix missing sidebar? (#1632) * maybe fix missing sidebar? * simplify * purge internal defaults & use theme config setting * formatting * refactor and simplify toctree code * DOC: Add missing "footer_center" in layout overview diagram (#1640) * Make bootstrap globally available (#1639) * Make bootstrap globally available * Include docs about bootstrap programmatic API * Add Brightway to Featured Example Gallery Grid (#1580) * initial commit * test: the png images are not build during tests --------- Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * fix: move the release instructions to the repository (#1621) * fix: update text and links * fix: add code highlight * fix: wire correct file in our documentation * chore: trigger CI * remove mention of semantic versioning Co-authored-by: Daniel McCloy <dan@mccloy.info> * refactor: lint * Update RELEASE.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Make search event listener only trigger with “K”/“k” (#1646) * More speedups to section TOC rendering (#1642) * small refactor, comments, cleanup * docstring cleanups * mark as unsafe for parallel write * Update src/pydata_sphinx_theme/toctree.py * Allow only theme_footer_center to be set (#1653) * fix: allow user to control the back-to-top button presence (#1616) * fix: put the btt button closer to age bottom * test: remove the btt button to check * test: fallback to default behaviour * refactor: rollback to previous state * use proper variable name * Update src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * remove toggle button for secondary sidebar if empty (#1637) * in CIs, pin sphinx dev temporarily * bump: 0.15.1 -> 0.15.2 * bump version to dev * FIX make theme switcher have consistent widths (#1651) * unpin sphinx in CI (#1665) * FIX make search button closer to other icons in topbar (#1659) * Build(deps): Bump actions/cache from 3 to 4 (#1667) Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](https://github.com/actions/cache/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * update dependabot labels (#1668) * only do security updates for NPM (#1674) * Restore search snippet highlights in search results page (#1678) * Apply default_mode to the html data-theme attribute (#1663) * Don't try to populate version switcher w/ relative path on local static site (#1660) * Don't try to populate version switcher on static sites * Fix comment spelling * Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * handle null result from queryselector (#1683) fix queryselector * Add pst-header-nav-item id to fix tests --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Angus Hollands <goosey15@gmail.com> Co-authored-by: Sebastiaan Huber <mail@sphuber.net> Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Peyton Murray <peynmurray@gmail.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Michael Wisely <108433848+michael-wisely-gravwell@users.noreply.github.com> Co-authored-by: Michael Weinold <23102087+michaelweinold@users.noreply.github.com> Co-authored-by: Philipp A <flying-sheep@web.de> Co-authored-by: Colin Marquardt <cmarqu42@gmail.com> Co-authored-by: Pierre Marchand <PierreMarchand20@users.noreply.github.com> Co-authored-by: Yao Xiao <108576690+Charlie-XIAO@users.noreply.github.com> Co-authored-by: Charles <peacech@gmail.com> Co-authored-by: David Stansby <dstansby@gmail.com> * Merge main into feature-focus (#1708) * Build(deps): Bump actions/setup-python from 4 to 5 (#1590) Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5. - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/v4...v5) --- updated-dependencies: - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Use pytest-regressions to mark expected a11y test failures (#1501) * Use pytest-regressions with a11y tests to mark expected failures * Update tests/test_a11y.py * frozen data class * Revert "frozen data class" This reverts commit 3b0c73e93d1f1b52f45b4918015c66fe5142c294. --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * FIX: avoid implicit string comparison in Sphinx 7.26 (#1592) * FIX: avoid implicit string comparison in Sphinx 7.26 * lint --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Build(deps): Bump actions/upload-artifact from 3 to 4 (#1598) Bumps [actions/upload-artifact](https://github.com/actions/upload-artifact) from 3 to 4. - [Release notes](https://github.com/actions/upload-artifact/releases) - [Commits](https://github.com/actions/upload-artifact/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/upload-artifact dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update fontawesome from 6.1.2 to 6.5.1 (#1600) * Fix landmark-unique error due to in-page TOC (#1607) * landmark unique error due to in-page TOC * Apply suggestions from code review Co-authored-by: Tania Allard <taniar.allard@gmail.com> * fix lint? --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Feature: Add support for per-page secondary sidebar content (#1572) * Add ability to set per-page secondary sidebars * Add additional secondary sidebar content tests; expanded utils docstring * Update translation files (#1606) * Bump minimum Python from 3.8 to 3.9; add 3.12 to CIs (#1610) drop py3.8, add py3.12 * Fix: more efficient determination of when to hide primary sidebar (#1609) * minor refactors suggested by Ruff * move TOC generation from layout.html to sidebar-primary.html * replace @lru_cache(None) with plain @cache * get sidebar TOC length without rendering it * fixup rebase/stash snafu * bugfix * Fix "More" links in mobile sidebar (#1604) Fix #1603 * bump: 0.14.4 → 0.15.0rc0 * Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po in fr (#1618) i18n: Translate sphinx.po in fr 100% translated source file: 'sphinx.po' on 'fr'. Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> * bump: 0.14.4 → 0.15.0 * fix: drop the dev test (#1623) * fix: remove Site navigation header (#1615) * fix: remove Site navigation header * test: edit the test suit * fix: align all breadcrumb elements (#1619) * fix: log information when warnings are disabled (#1617) * bump: 0.15.0 → 0.15.1 * back to dev * fix: align the search button with other icons (#1620) * test: display the search button for demo purposes * fix: only display the search icon * fix: remove needless adjustements * fix: rollback to default search * chore: trigger CI * Fix sticky header (#1630) * Fix sticky header * regression test * maybe fix missing sidebar? (#1632) * maybe fix missing sidebar? * simplify * purge internal defaults & use theme config setting * formatting * refactor and simplify toctree code * DOC: Add missing "footer_center" in layout overview diagram (#1640) * Make bootstrap globally available (#1639) * Make bootstrap globally available * Include docs about bootstrap programmatic API * Add Brightway to Featured Example Gallery Grid (#1580) * initial commit * test: the png images are not build during tests --------- Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> * fix: move the release instructions to the repository (#1621) * fix: update text and links * fix: add code highlight * fix: wire correct file in our documentation * chore: trigger CI * remove mention of semantic versioning Co-authored-by: Daniel McCloy <dan@mccloy.info> * refactor: lint * Update RELEASE.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Make search event listener only trigger with “K”/“k” (#1646) * More speedups to section TOC rendering (#1642) * small refactor, comments, cleanup * docstring cleanups * mark as unsafe for parallel write * Update src/pydata_sphinx_theme/toctree.py * Allow only theme_footer_center to be set (#1653) * fix: allow user to control the back-to-top button presence (#1616) * fix: put the btt button closer to age bottom * test: remove the btt button to check * test: fallback to default behaviour * refactor: rollback to previous state * use proper variable name * Update src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * remove toggle button for secondary sidebar if empty (#1637) * in CIs, pin sphinx dev temporarily * bump: 0.15.1 -> 0.15.2 * bump version to dev * FIX make theme switcher have consistent widths (#1651) * unpin sphinx in CI (#1665) * FIX make search button closer to other icons in topbar (#1659) * Build(deps): Bump actions/cache from 3 to 4 (#1667) Bumps [actions/cache](https://github.com/actions/cache) from 3 to 4. - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](https://github.com/actions/cache/compare/v3...v4) --- updated-dependencies: - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * update dependabot labels (#1668) * only do security updates for NPM (#1674) * Restore search snippet highlights in search results page (#1678) * Apply default_mode to the html data-theme attribute (#1663) * Don't try to populate version switcher w/ relative path on local static site (#1660) * Don't try to populate version switcher on static sites * Fix comment spelling * Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * handle null result from queryselector (#1683) fix queryselector * ENH make search result heading a bit away from the search input box (#1690) ENH make search result heading a bit away from the search box * ENH animation for the top banner (#1693) * ENH animation for the top banner * unset forcefully set styles to let css take over; animation also added for version warning banner * make transition a bit longer * resolve conversations * retrigger CI * Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * docs: typo in a link in the release instructions (#1704) * Build(deps): Bump codecov/codecov-action from 3 to 4 (#1706) Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 3 to 4. - [Release notes](https://github.com/codecov/codecov-action/releases) - [Changelog](https://github.com/codecov/codecov-action/blob/main/CHANGELOG.md) - [Commits](https://github.com/codecov/codecov-action/compare/v3...v4) --- updated-dependencies: - dependency-name: codecov/codecov-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Build(deps): Bump treosh/lighthouse-ci-action from 10 to 11 (#1705) Bumps [treosh/lighthouse-ci-action](https://github.com/treosh/lighthouse-ci-action) from 10 to 11. - [Release notes](https://github.com/treosh/lighthouse-ci-action/releases) - [Commits](https://github.com/treosh/lighthouse-ci-action/compare/v10...v11) --- updated-dependencies: - dependency-name: treosh/lighthouse-ci-action dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Angus Hollands <goosey15@gmail.com> Co-authored-by: Sebastiaan Huber <mail@sphuber.net> Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Peyton Murray <peynmurray@gmail.com> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Michael Wisely <108433848+michael-wisely-gravwell@users.noreply.github.com> Co-authored-by: Michael Weinold <23102087+michaelweinold@users.noreply.github.com> Co-authored-by: Philipp A <flying-sheep@web.de> Co-authored-by: Colin Marquardt <cmarqu42@gmail.com> Co-authored-by: Pierre Marchand <PierreMarchand20@users.noreply.github.com> Co-authored-by: Yao Xiao <108576690+Charlie-XIAO@users.noreply.github.com> Co-authored-by: Charles <peacech@gmail.com> Co-authored-by: David Stansby <dstansby@gmail.com> * Make TOC sections expandable and collapsible by keyboard (#1582) * Consistent focus ring (first pass) (#1549) * wip * Style focus state in header nav * update focus ring style on all focussable elements * simplify * fix links in mobile sidebar overlay * put focus rings around a few more focusable elements * polish * update comment * review * better align focus ring on collapsible admonitions * comment and simplify sphinx-togglebutton focus ring * make css override more explicit * Fix SD link-card focus ring and on homepage, bring links inside card * Update docs/index.md --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> * Resolve current sidebar link notch and focus ring (#1561) * Fix sidebar current notch * focus-ring-radius * missed a spot 0.125rem * keep focus ring on top * Restyle Sphinx Design tabs (#1555) * restyle sphinx design tabs * increase panel border radius * increase line height, zero padding-y * use shadow variable * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Update src/pydata_sphinx_theme/assets/styles/extensions/_sphinx_design.scss * Fix tabbed panel colors (#1567) * aria attributes do not update if user uses mouse instead of keyboard * details/summary, no checkbox * clean up * details["open"] * make it work for nav level 0 * pull link outside of details tag * make it work with show nav level 0 * make level 0 heading clickable * comments * restore .current notches to toc parents * fix tests * clean up * more comments * make toggle icon bigger at level 0 * comments * clarify comment * remove list-captions class from in-page toc styles * Update tests/test_build.py * Update src/pydata_sphinx_theme/toctree.py Co-authored-by: Tania Allard <taniar.allard@gmail.com> * update test for verbose HTML boolean attribute * more HTML boolean attribute notation updates * Update comment about link vs non-link HTML structure --------- Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Independently style "Switch to stable version" link (#1721) * Independently style switch to stable version link * hover and focus * docs and css cleanup * Use focus ring Sass variables * text-wrap class * Update docs/user_guide/web-components.rst Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Update docs/user_guide/web-components.rst Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Update src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Update src/pydata_sphinx_theme/assets/styles/sections/_announcement.scss Co-authored-by: Tania Allard <taniar.allard@gmail.com> * use var --pst-color-danger-text --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> * Ensure old test files are removed * Run pre-commit * Add to the accessibility support section of the docs (#1730) * add entry to the docs * Apply suggestions from code review Co-authored-by: Daniel McCloy <dan@mccloy.info> --------- Co-authored-by: Tania Allard <taniar.allard@gmail.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> * Feature focus review fixes (#1736) * fix search bar hover * fix overlapping focus and hover rings on More dropdown toggle * point chevron up * fix translations * conf.py fixes * Revert changes to horizontal spacing in header nav (#1738) * revert changes to horizontal spacing in header nav * keep outline offset at 3px * set Codecov verbose flag to true (#1743) --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: gabalafou <gabriel@fouasnon.com> Co-authored-by: Daniel McCloy <dan@mccloy.info> Co-authored-by: Rambaud Pierrick <12rambau@users.noreply.github.com> Co-authored-by: gresavage <tomgresavage@gmail.com> Co-authored-by: tgresavage <thomas.gresavage.ext@afresearchlab.com> Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ned Batchelder <ned@nedbatchelder.com> Co-authored-by: Adam Porter <adam@alphapapa.net> Co-authored-by: Denis Bitouzé <dbitouze@wanadoo.fr> Co-authored-by: Stuart Mumford <stuart@cadair.com> Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com> Co-authored-by: Harutaka Kawamura <hkawamura0130@gmail.com> Co-authored-by: jourlez <josuecr.288@gmail.com> Co-authored-by: Chris Holdgraf <choldgraf@berkeley.edu> Co-authored-by: Angus Hollands <goosey15@gmail.com> Co-authored-by: Sebastiaan Huber <mail@sphuber.net> Co-authored-by: Peyton Murray <peynmurray@gmail.com> Co-authored-by: Joris Van den Bossche <jorisvandenbossche@gmail.com> Co-authored-by: Michael Wisely <108433848+michael-wisely-gravwell@users.noreply.github.com> Co-authored-by: Michael Weinold <23102087+michaelweinold@users.noreply.github.com> Co-authored-by: Philipp A <flying-sheep@web.de> Co-authored-by: Colin Marquardt <cmarqu42@gmail.com> Co-authored-by: Pierre Marchand <PierreMarchand20@users.noreply.github.com> Co-authored-by: Yao Xiao <108576690+Charlie-XIAO@users.noreply.github.com> Co-authored-by: Charles <peacech@gmail.com> Co-authored-by: David Stansby <dstansby@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
IMPORTANT: this PR is against
feature-focusbranch notmain. Style fixes related to interaction state (focus, hover, current) will be collected in small increments intofeature-focusbefore being merged intomain.The goal of this PR is to make it possible to expand and collapse sections of the table of contents using only the keyboard.
At a high level, the strategy is to replace the label + hidden checkbox implementation with details + summary. The label unfortunately is not natively keyboard focusable and clickable, and even if you do give it a
tabindex="0", which will enable you to focus it with your keyboard, you will still not be able to use Space or Enter to activate the checkbox in the same way that you can with a mouse click.I also went ahead and fixed the sidebar table of contents for
show_nav_level == 0because it's currently broken on main; the toggle icon takes up an entire line on its own line, rather than floating to the right of the togglable heading, which is different and worse than the behavior reported in #1251. (This PR should fix #1251.) On this subject, is there a way to create a single page in the site docs that renders a show_nav_level 0 sidebar TOC? I tried creating a new .rst page with the following line as the very first line, but it didn't work for me:I tested this page on Firefox, Safari, and Chrome on Mac, with show_nav_level 0, with dark mode, and in the mobile sidebar overlay. One odd thing I noticed in Safari is that you can Tab-key navigate to nested disclosure widgets even if the parent disclosure widget is collapsed and they are therefore hidden.
Here's a video showing the basic behavior:
Screen.Recording.2023-12-19.at.16.12.50.mov
Closes #1251