Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge main into feature-focus #1708

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
07dcd14
Build(deps): Bump actions/setup-python from 4 to 5 (#1590)
dependabot[bot] Dec 11, 2023
7bdd4c1
Use pytest-regressions to mark expected a11y test failures (#1501)
gabalafou Dec 11, 2023
8bc48a9
FIX: avoid implicit string comparison in Sphinx 7.26 (#1592)
agoose77 Dec 13, 2023
2c3f8a3
Build(deps): Bump actions/upload-artifact from 3 to 4 (#1598)
dependabot[bot] Dec 18, 2023
3de3059
Update fontawesome from 6.1.2 to 6.5.1 (#1600)
sphuber Dec 18, 2023
5b417ad
Fix landmark-unique error due to in-page TOC (#1607)
gabalafou Dec 23, 2023
b731dc2
Feature: Add support for per-page secondary sidebar content (#1572)
peytondmurray Dec 26, 2023
4ef6725
Update translation files (#1606)
gabalafou Dec 29, 2023
068ac7b
Bump minimum Python from 3.8 to 3.9; add 3.12 to CIs (#1610)
drammock Jan 2, 2024
fcde006
Fix: more efficient determination of when to hide primary sidebar (#1…
drammock Jan 2, 2024
7d01e01
Fix "More" links in mobile sidebar (#1604)
gabalafou Jan 2, 2024
469b921
bump: 0.14.4 → 0.15.0rc0
12rambau Jan 3, 2024
8e1bb95
Updates for file src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx…
transifex-integration[bot] Jan 3, 2024
921474c
bump: 0.14.4 → 0.15.0
12rambau Jan 4, 2024
4aa82e2
fix: drop the dev test (#1623)
12rambau Jan 4, 2024
e0b39b8
fix: remove Site navigation header (#1615)
12rambau Jan 4, 2024
86a5b6c
fix: align all breadcrumb elements (#1619)
12rambau Jan 4, 2024
287382d
fix: log information when warnings are disabled (#1617)
12rambau Jan 4, 2024
b8591f8
bump: 0.15.0 → 0.15.1
12rambau Jan 4, 2024
324b361
back to dev
12rambau Jan 4, 2024
c25f233
fix: align the search button with other icons (#1620)
12rambau Jan 4, 2024
1b599c4
Fix sticky header (#1630)
gabalafou Jan 8, 2024
d4f888e
maybe fix missing sidebar? (#1632)
drammock Jan 9, 2024
ea92bd1
DOC: Add missing "footer_center" in layout overview diagram (#1640)
jorisvandenbossche Jan 10, 2024
82eabda
Make bootstrap globally available (#1639)
michael-wisely-gravwell Jan 10, 2024
2057612
Add Brightway to Featured Example Gallery Grid (#1580)
michaelweinold Jan 11, 2024
f50e7b9
fix: move the release instructions to the repository (#1621)
12rambau Jan 12, 2024
fff6837
Make search event listener only trigger with “K”/“k” (#1646)
flying-sheep Jan 15, 2024
03c73c4
More speedups to section TOC rendering (#1642)
drammock Jan 18, 2024
80b3e51
Allow only theme_footer_center to be set (#1653)
cmarqu Jan 18, 2024
5fc1452
fix: allow user to control the back-to-top button presence (#1616)
12rambau Jan 18, 2024
cfd3cb5
remove toggle button for secondary sidebar if empty (#1637)
PierreMarchand20 Jan 18, 2024
f420c13
in CIs, pin sphinx dev temporarily
drammock Jan 18, 2024
6010af1
bump: 0.15.1 -> 0.15.2
drammock Jan 18, 2024
093c4e0
bump version to dev
drammock Jan 18, 2024
a135c20
FIX make theme switcher have consistent widths (#1651)
Charlie-XIAO Jan 19, 2024
7bc672f
unpin sphinx in CI (#1665)
drammock Jan 19, 2024
8cf45f8
FIX make search button closer to other icons in topbar (#1659)
Charlie-XIAO Jan 19, 2024
b00124d
Build(deps): Bump actions/cache from 3 to 4 (#1667)
dependabot[bot] Jan 22, 2024
53a9a02
update dependabot labels (#1668)
drammock Jan 22, 2024
115343c
only do security updates for NPM (#1674)
drammock Jan 22, 2024
6919a8a
Restore search snippet highlights in search results page (#1678)
gabalafou Jan 23, 2024
3e44d1c
Apply default_mode to the html data-theme attribute (#1663)
char101 Jan 24, 2024
c04f042
Don't try to populate version switcher w/ relative path on local stat…
dstansby Jan 24, 2024
11af3fc
handle null result from queryselector (#1683)
drammock Jan 28, 2024
b046785
ENH make search result heading a bit away from the search input box (…
Charlie-XIAO Jan 31, 2024
4c7572b
ENH animation for the top banner (#1693)
Charlie-XIAO Feb 1, 2024
4e00c65
docs: typo in a link in the release instructions (#1704)
12rambau Feb 3, 2024
11a1d6e
Build(deps): Bump codecov/codecov-action from 3 to 4 (#1706)
dependabot[bot] Feb 5, 2024
17dba55
Build(deps): Bump treosh/lighthouse-ci-action from 10 to 11 (#1705)
dependabot[bot] Feb 5, 2024
c555aae
Merge branch 'main' into merge-main-again-feature-focus
gabalafou Feb 5, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ jobs:
run: pytest -m "not a11y" --color=yes --cov --cov-report=xml
- name: Upload to Codecov
if: matrix.python-version == '3.12' && matrix.os == 'ubuntu-latest'
uses: codecov/codecov-action@v3
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true
Expand Down Expand Up @@ -194,7 +194,7 @@ jobs:
sphinx-build audit/site audit/_build
# The lighthouse audit runs directly on the HTML files, no serving needed
- name: Audit with Lighthouse
uses: treosh/lighthouse-ci-action@v10
uses: treosh/lighthouse-ci-action@v11
with:
configPath: ".github/workflows/lighthouserc.json"
temporaryPublicStorage: true
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ These steps should be taken in order to create a new release![^release-refs]

**Make the release**

- [ ] [Start a new GitHub release](https://github.com/pandas-dev/pydata-sphinx-theme/releases/new)
- [ ] [Start a new GitHub release](https://github.com/pydata/pydata-sphinx-theme/releases/new)
- Call the release the current version, e.g. `v0.2.0`
- In the **`Choose a Tag:`** dropdown, type in the release name (e.g., `v0.2.0`) and click "Create new tag"
- In the **`Target:`** dropdown, pin it to the release commit that you've just pushed.
Expand Down
25 changes: 24 additions & 1 deletion src/pydata_sphinx_theme/assets/scripts/pydata-sphinx-theme.js
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,8 @@ function showVersionWarningBanner(data) {
const bold = document.createElement("strong");
const button = document.createElement("a");
// these classes exist since pydata-sphinx-theme v0.10.0
outer.classList = "bd-header-version-warning container-fluid";
// the init class is used for animation
outer.classList = "bd-header-version-warning container-fluid init";
middle.classList = "bd-header-announcement__content";
inner.classList = "sidebar-message";
button.classList =
Expand Down Expand Up @@ -516,6 +517,28 @@ function showVersionWarningBanner(data) {
inner.appendChild(button);
const skipLink = document.getElementById("pst-skip-link");
skipLink.after(outer);
// At least 3rem height
const autoHeight = Math.max(
outer.offsetHeight,
3 * parseFloat(getComputedStyle(document.documentElement).fontSize)
);
// Set height and vertical padding to 0 to prepare the height transition
outer.style.setProperty("height", 0);
outer.style.setProperty("padding-top", 0);
outer.style.setProperty("padding-bottom", 0);
outer.classList.remove("init");
// Set height to the computed height with a small timeout to activate the transition
setTimeout(() => {
outer.style.setProperty("height", `${autoHeight}px`);
// Wait for a bit more than 300ms (the transition duration) then remove the
// forcefully set styles and let CSS take over
setTimeout(() => {
outer.style.removeProperty("padding-top");
outer.style.removeProperty("padding-bottom");
outer.style.removeProperty("height");
outer.style.setProperty("min-height", "3rem");
}, 320);
}, 10);
}

/*******************************************************************************
Expand Down
2 changes: 1 addition & 1 deletion src/pydata_sphinx_theme/assets/styles/pages/_search.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
div#search-results {
> h2 {
font-size: var(--pst-font-size-icon);
margin-top: 0;
margin-top: 1rem;
}

p.search-summary {
Expand Down
26 changes: 9 additions & 17 deletions src/pydata_sphinx_theme/assets/styles/sections/_announcement.scss
Original file line number Diff line number Diff line change
@@ -1,34 +1,30 @@
.bd-header-version-warning,
.bd-header-announcement {
min-height: 3rem;
width: 100%;
display: flex;
position: relative;
align-items: center;
justify-content: center;
text-align: center;
transition: height 300ms ease-in-out;
overflow-y: hidden;
padding: 0.5rem 12.5%; // Horizontal padding so the width is 75%
// One breakpoint less than $breakpoint-sidebar-primary. See variables/_layout.scss for more info.
@include media-breakpoint-down(lg) {
// Announcements can take a bit more width on mobile
padding: 0.5rem 2%;
}

&.init {
position: fixed;
visibility: hidden;
}

p {
font-weight: bold;
margin: 0;
}

&:after {
position: absolute;
width: 100%;
height: 100%;
left: 0;
top: 0;
content: "";
z-index: -1; // So it doesn't hover over the content
}

&:empty {
display: none;
}
Expand All @@ -41,13 +37,9 @@

// Bg color is now defined in the theme color palette - using our secondary color
.bd-header-announcement {
&:after {
background-color: var(--pst-color-secondary-bg);
}
background-color: var(--pst-color-secondary-bg);
}

.bd-header-version-warning {
&:after {
background-color: var(--pst-color-danger-bg);
}
background-color: var(--pst-color-danger-bg);
}
17 changes: 9 additions & 8 deletions src/pydata_sphinx_theme/locale/ca/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ msgid ""
msgstr ""
"Project-Id-Version: PROJECT VERSION\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2023-12-21 08:09-0700\n"
"POT-Creation-Date: 2024-02-05 09:55-0500\n"
"PO-Revision-Date: 2023-04-14 14:57+0000\n"
"Last-Translator: Oriol Abril-Pla <oriol.abril.pla@gmail.com>, 2023\n"
"Language: ca\n"
Expand All @@ -29,11 +29,11 @@ msgstr ""
msgid "Click to collapse"
msgstr ""

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:53
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:38
msgid "Skip to main content"
msgstr "Salta al contingut principal"

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:64
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:50
msgid "Back to top"
msgstr ""

Expand Down Expand Up @@ -101,12 +101,8 @@ msgstr "Índex de Mòduls Python"
msgid "Last updated on %(last_updated)s."
msgstr "Última actualització el %(last_updated)s."

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html:6
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html:7
msgid "Site Navigation"
msgstr "Navegació del lloc"

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/page-toc.html:8
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html:43
msgid "On this page"
msgstr "Continguts de la pàgina"

Expand Down Expand Up @@ -159,6 +155,11 @@ msgstr ""
"theme.readthedocs.io/en/stable/index.html\">Tema PyData Sphinx</a> "
"%(theme_version)s."

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html:3
#, fuzzy
msgid "Site navigation"
msgstr "Navegació del lloc"

#~ msgid "Breadcrumbs"
#~ msgstr "Rutes de navegació"

Expand Down
19 changes: 11 additions & 8 deletions src/pydata_sphinx_theme/locale/en/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ msgid ""
msgstr ""
"Project-Id-Version: PROJECT VERSION\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2023-12-21 08:09-0700\n"
"POT-Creation-Date: 2024-02-05 09:55-0500\n"
"PO-Revision-Date: 2023-02-16 13:19-0500\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language: en\n"
Expand All @@ -26,11 +26,11 @@ msgstr ""
msgid "Click to collapse"
msgstr ""

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:53
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:38
msgid "Skip to main content"
msgstr ""

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:64
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:50
msgid "Back to top"
msgstr ""

Expand Down Expand Up @@ -98,12 +98,8 @@ msgstr ""
msgid "Last updated on %(last_updated)s."
msgstr ""

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html:6
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html:7
msgid "Site Navigation"
msgstr ""

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/page-toc.html:8
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html:43
msgid "On this page"
msgstr ""

Expand Down Expand Up @@ -151,6 +147,10 @@ msgid ""
"%(theme_version)s."
msgstr ""

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html:3
msgid "Site navigation"
msgstr ""

#~ msgid "Breadcrumbs"
#~ msgstr ""

Expand All @@ -166,3 +166,6 @@ msgstr ""
#~ msgid "Twitter"
#~ msgstr ""

#~ msgid "Site Navigation"
#~ msgstr ""

17 changes: 9 additions & 8 deletions src/pydata_sphinx_theme/locale/es/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ msgid ""
msgstr ""
"Project-Id-Version: PROJECT VERSION\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2023-12-21 08:09-0700\n"
"POT-Creation-Date: 2024-02-05 09:55-0500\n"
"PO-Revision-Date: 2023-04-14 14:57+0000\n"
"Last-Translator: Rambaud Pierrick <pierrick.rambaud49@gmail.com>, 2023\n"
"Language: es\n"
Expand All @@ -30,11 +30,11 @@ msgstr ""
msgid "Click to collapse"
msgstr ""

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:53
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:38
msgid "Skip to main content"
msgstr "Saltar al contenido principal"

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:64
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:50
msgid "Back to top"
msgstr ""

Expand Down Expand Up @@ -102,12 +102,8 @@ msgstr "Índice de Módulos Python"
msgid "Last updated on %(last_updated)s."
msgstr "Actualizado por última vez en %(last_updated)s."

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html:6
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html:7
msgid "Site Navigation"
msgstr "Navegación del sitio"

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/page-toc.html:8
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html:43
msgid "On this page"
msgstr "En esta página"

Expand Down Expand Up @@ -160,6 +156,11 @@ msgstr ""
"theme.readthedocs.io/en/stable/index.html\">Tema PyData Sphinx</a> "
"%(theme_version)s."

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html:3
#, fuzzy
msgid "Site navigation"
msgstr "Navegación del sitio"

#~ msgid "Breadcrumbs"
#~ msgstr "Migas de pan"

Expand Down
24 changes: 10 additions & 14 deletions src/pydata_sphinx_theme/locale/fr/LC_MESSAGES/sphinx.po
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,13 @@
#
# Translators:
# Rambaud Pierrick <pierrick.rambaud49@gmail.com>, 2024
#
msgid ""
msgstr ""
"Project-Id-Version: PROJECT VERSION\n"
"Report-Msgid-Bugs-To: EMAIL@ADDRESS\n"
"POT-Creation-Date: 2023-12-21 08:09-0700\n"
"POT-Creation-Date: 2024-02-05 09:55-0500\n"
"PO-Revision-Date: 2023-04-14 14:57+0000\n"
"Last-Translator: Rambaud Pierrick <pierrick.rambaud49@gmail.com>, 2024\n"
"Language-Team: French (https://app.transifex.com/12rambau/teams/166811/fr/)\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Generated-By: Babel 2.13.0\n"
"Language: fr\n"
"Language-Team: French "
"(https://app.transifex.com/12rambau/teams/166811/fr/)\n"
Expand All @@ -36,11 +30,11 @@ msgstr ""
msgid "Click to collapse"
msgstr ""

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:53
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:38
msgid "Skip to main content"
msgstr "Passer au contenu principal"

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:64
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/layout.html:50
msgid "Back to top"
msgstr "Haut de page"

Expand Down Expand Up @@ -108,12 +102,8 @@ msgstr "Index des modules Python"
msgid "Last updated on %(last_updated)s."
msgstr "Mis à jour le %(last_updated)s."

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html:6
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/navbar-nav.html:7
msgid "Site Navigation"
msgstr "Navigation du site"

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/components/page-toc.html:8
#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html:43
msgid "On this page"
msgstr "Sur cette page"

Expand Down Expand Up @@ -166,6 +156,11 @@ msgstr ""
"theme.readthedocs.io/en/stable/index.html\">Thème PyData Sphinx</a> "
"%(theme_version)s."

#: src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html:3
#, fuzzy
msgid "Site navigation"
msgstr "Navigation du site"

#~ msgid "Breadcrumbs"
#~ msgstr "Fils d'Ariane"

Expand All @@ -180,3 +175,4 @@ msgstr ""

#~ msgid "Twitter"
#~ msgstr "Twitter"

Loading
Loading