{# Main content area #} {% block docs_main %}
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/footer.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/footer.html index 691cd5f6d..323864da3 100644 --- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/footer.html +++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/footer.html @@ -1,4 +1,4 @@ -{% if theme_footer_start or theme_footer_end %} +{% if theme_footer_start or theme_footer_center or theme_footer_end %}
{% if theme_footer_start %}
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html index 671648440..82110d9a5 100644 --- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html +++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/header.html @@ -39,7 +39,7 @@
{% endfor %} - {% if not remove_sidebar_secondary %} + {% if not remove_sidebar_secondary and secondary_sidebar_items %} diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-secondary.html b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-secondary.html index b3f880fd0..9f36cc470 100644 --- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-secondary.html +++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/sections/sidebar-secondary.html @@ -1,6 +1,7 @@ -{% if theme_secondary_sidebar_items -%} +{% if secondary_sidebar_items -%}
-{% for toc_item in theme_secondary_sidebar_items %} +{# Note: secondary_sidebar_items is set by set_secondary_sidebar_items() in utils.py #} +{% for toc_item in secondary_sidebar_items %}
{% include toc_item %}
{% endfor %}
diff --git a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf index 946bcdd9b..103a0a4f5 100644 --- a/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf +++ b/src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf @@ -37,6 +37,7 @@ pygment_light_style = a11y-high-contrast-light pygment_dark_style = a11y-high-contrast-dark logo = surface_warnings = True +back_to_top_button = True # Template placement in theme layouts navbar_start = navbar-logo diff --git a/src/pydata_sphinx_theme/toctree.py b/src/pydata_sphinx_theme/toctree.py index 629b62e72..69625b5b8 100644 --- a/src/pydata_sphinx_theme/toctree.py +++ b/src/pydata_sphinx_theme/toctree.py @@ -1,6 +1,6 @@ """Methods to build the toctree used in the html pages.""" -from functools import lru_cache +from functools import cache from itertools import count from typing import Iterator, List, Union from urllib.parse import urlparse @@ -9,8 +9,7 @@ from bs4 import BeautifulSoup from docutils import nodes from docutils.nodes import Node -from sphinx import addnodes -from sphinx.addnodes import toctree as toctree_node +from sphinx.addnodes import toctree as TocTreeNodeClass from sphinx.application import Sphinx from sphinx.environment.adapters.toctree import TocTree from sphinx.locale import _ @@ -32,12 +31,60 @@ def add_inline_math(node: Node) -> str: ) +def _get_ancestor_pagename(app: Sphinx, pagename: str, startdepth: int) -> str: + """Get the name of `pagename`'s ancestor that is rooted `startdepth` levels below the global root.""" + toctree = TocTree(app.env) + if sphinx.version_info[:2] >= (7, 2): + from sphinx.environment.adapters.toctree import _get_toctree_ancestors + + ancestors = [*_get_toctree_ancestors(app.env.toctree_includes, pagename)] + else: + ancestors = toctree.get_toctree_ancestors(pagename) + try: + out = ancestors[-startdepth] + except IndexError: + # eg for index.rst, but also special pages such as genindex, py-modindex, search + # those pages don't have a "current" element in the toctree, so we can + # directly return None instead of using the default sphinx + # toctree.get_toctree_for(pagename, app.builder, collapse, **kwargs) + out = None + return out, toctree + + def add_toctree_functions( app: Sphinx, pagename: str, templatename: str, context, doctree ) -> None: """Add functions so Jinja templates can add toctree objects.""" - @lru_cache(maxsize=None) + def suppress_sidebar_toctree(startdepth: int = 1, **kwargs): + """Check if there's a sidebar TocTree that needs to be rendered. + + Parameters: + startdepth : The level of the TocTree at which to start. 0 includes the + entire TocTree for the site; 1 (default) gets the TocTree for the current + top-level section. + + kwargs : passed to the Sphinx `toctree` template function. + """ + ancestorname, toctree_obj = _get_ancestor_pagename( + app=app, pagename=pagename, startdepth=startdepth + ) + if ancestorname is None: + return True # suppress + if kwargs.get("includehidden", False): + # if ancestor is found and `includehidden=True` we're guaranteed there's a + # TocTree to be shown, so don't suppress + return False + + # we've found an ancestor page, but `includehidden=False` so we can't be sure if + # there's a TocTree fragment that should be shown on this page; unfortunately we + # must resolve the whole TOC subtree to find out + toctree = get_nonroot_toctree( + app, pagename, ancestorname, toctree_obj, **kwargs + ) + return toctree is None + + @cache def get_or_create_id_generator(base_id: str) -> Iterator[str]: for n in count(start=1): if n == 1: @@ -53,7 +100,7 @@ def unique_html_id(base_id: str): """ return next(get_or_create_id_generator(base_id)) - @lru_cache(maxsize=None) + @cache def generate_header_nav_before_dropdown(n_links_before_dropdown): """The cacheable part.""" try: @@ -69,6 +116,9 @@ def generate_header_nav_before_dropdown(n_links_before_dropdown): if sphinx.version_info[:2] >= (7, 2): from sphinx.environment.adapters.toctree import _get_toctree_ancestors + # NOTE: `env.toctree_includes` is a dict mapping pagenames to any (possibly + # hidden) TocTree directives on that page (i.e., the "child" pages nested + # under `pagename`). active_header_page = [ *_get_toctree_ancestors(app.env.toctree_includes, pagename) ] @@ -78,14 +128,18 @@ def generate_header_nav_before_dropdown(n_links_before_dropdown): # The final list item will be the top-most ancestor active_header_page = active_header_page[-1] - # Find the root document because it lists our top-level toctree pages - root = app.env.tocs[app.config.root_doc] + # NOTE: `env.tocs` is a dict mapping pagenames to hierarchical bullet-lists + # ("nodetrees" in Sphinx parlance) of in-page headings (including `toctree::` + # directives). Thus the `tocs` of `root_doc` yields the top-level pages that sit + # just below the root of our site + root_toc = app.env.tocs[app.config.root_doc] - # Iterate through each toctree node in the root document - # Grab the toctree pages and find the relative link + title. links_html = [] - # TODO: use `root.findall(toctree_node)` once docutils min version >=0.18.1 - for toc in traverse_or_findall(root, toctree_node): + # Iterate through each node in the root document toc. + # Grab the toctree pages and find the relative link + title. + for toc in traverse_or_findall(root_toc, TocTreeNodeClass): + # TODO: ↑↑↑ use `root_toc.findall(TocTreeNodeClass)` ↑↑↑ + # once docutils min version >=0.18.1 for title, page in toc.attributes["entries"]: # if the page is using "self" use the correct link page = toc.attributes["parent"] if page == "self" else page @@ -194,7 +248,7 @@ def generate_header_nav_html( # Cache this function because it is expensive to run, and because Sphinx # somehow runs this twice in some circumstances in unpredictable ways. - @lru_cache(maxsize=None) + @cache def generate_toctree_html( kind: str, startdepth: int = 1, show_nav_level: int = 1, **kwargs ) -> Union[BeautifulSoup, str]: @@ -216,18 +270,31 @@ def generate_toctree_html( kind : "sidebar" or "raw". Whether to generate HTML meant for sidebar navigation ("sidebar") or to return the raw BeautifulSoup object ("raw"). startdepth : The level of the toctree at which to start. By default, for the navbar uses the normal toctree (`startdepth=0`), and for the sidebar starts from the second level (`startdepth=1`). show_nav_level : The level of the navigation bar to toggle as visible on page load. By default, this level is 1, and only top-level pages are shown, with drop-boxes to reveal children. Increasing `show_nav_level` will show child levels as well. - kwargs: passed to the Sphinx `toctree` template function. + kwargs : passed to the Sphinx `toctree` template function. Returns: HTML string (if kind == "sidebar") OR BeautifulSoup object (if kind == "raw") """ if startdepth == 0: - toc_sphinx = context["toctree"](**kwargs) + html_toctree = context["toctree"](**kwargs) else: + # find relevant ancestor page; some pages (search, genindex) won't have one + ancestorname, toctree_obj = _get_ancestor_pagename( + app=app, pagename=pagename, startdepth=startdepth + ) + if ancestorname is None: + raise RuntimeError( + "Template requested to generate a TocTree fragment but no suitable " + "ancestor found to act as root node. Please report this to theme " + "developers." + ) # select the "active" subset of the navigation tree for the sidebar - toc_sphinx = index_toctree(app, pagename, startdepth, **kwargs) + toctree_element = get_nonroot_toctree( + app, pagename, ancestorname, toctree_obj, **kwargs + ) + html_toctree = app.builder.render_partial(toctree_element)["fragment"] - soup = BeautifulSoup(toc_sphinx, "html.parser") + soup = BeautifulSoup(html_toctree, "html.parser") # pair "current" with "active" since that's what we use w/ bootstrap for li in soup("li", {"class": "current"}): @@ -244,7 +311,7 @@ def generate_toctree_html( if kind == "sidebar": # Add bootstrap classes for first `ul` items for ul in soup("ul", recursive=False): - ul.attrs["class"] = ul.attrs.get("class", []) + ["nav", "bd-sidenav"] + ul.attrs["class"] = [*ul.attrs.get("class", []), "nav", "bd-sidenav"] # Add collapse boxes for parts/captions. # Wraps the TOC part in an extra
    to behave like chapters with toggles @@ -279,7 +346,7 @@ def generate_toctree_html( return soup - @lru_cache(maxsize=None) + @cache def generate_toc_html(kind: str = "html") -> BeautifulSoup: """Return the within-page TOC links in HTML.""" if "toc" not in context: @@ -292,22 +359,22 @@ def add_header_level_recursive(ul, level): if ul is None: return if level <= (context["theme_show_toc_level"] + 1): - ul["class"] = ul.get("class", []) + ["visible"] + ul["class"] = [*ul.get("class", []), "visible"] for li in ul("li", recursive=False): - li["class"] = li.get("class", []) + [f"toc-h{level}"] + li["class"] = [*li.get("class", []), f"toc-h{level}"] add_header_level_recursive(li.find("ul", recursive=False), level + 1) add_header_level_recursive(soup.find("ul"), 1) # Add in CSS classes for bootstrap for ul in soup("ul"): - ul["class"] = ul.get("class", []) + ["nav", "section-nav", "flex-column"] + ul["class"] = [*ul.get("class", []), "nav", "section-nav", "flex-column"] for li in soup("li"): - li["class"] = li.get("class", []) + ["nav-item", "toc-entry"] + li["class"] = [*li.get("class", []), "nav-item", "toc-entry"] if li.find("a"): a = li.find("a") - a["class"] = a.get("class", []) + ["nav-link"] + a["class"] = [*a.get("class", []), "nav-link"] # If we only have one h1 header, assume it's a title h1_headers = soup.select(".toc-h1") @@ -345,6 +412,7 @@ def navbar_align_class() -> List[str]: context["unique_html_id"] = unique_html_id context["generate_header_nav_html"] = generate_header_nav_html + context["suppress_sidebar_toctree"] = suppress_sidebar_toctree context["generate_toctree_html"] = generate_toctree_html context["generate_toc_html"] = generate_toc_html context["navbar_align_class"] = navbar_align_class @@ -371,7 +439,7 @@ def add_collapse_checkboxes(soup: BeautifulSoup) -> None: continue # Add a class to indicate that this has children. - element["class"] = classes + ["has-children"] + element["class"] = [*classes, "has-children"] # We're gonna add a checkbox. toctree_checkbox_count += 1 @@ -409,78 +477,53 @@ def add_collapse_checkboxes(soup: BeautifulSoup) -> None: element.insert(1, checkbox) -def get_local_toctree_for( - self: TocTree, indexname: str, docname: str, builder, collapse: bool, **kwargs -) -> List[BeautifulSoup]: - """Return the "local" TOC nodetree (relative to `indexname`).""" - # this is a copy of `TocTree.get_toctree_for`, but where the sphinx version - # always uses the "root" doctree: - # doctree = self.env.get_doctree(self.env.config.root_doc) - # we here use the `indexname` additional argument to be able to use a subset - # of the doctree (e.g. starting at a second level for the sidebar): - # doctree = app.env.tocs[indexname].deepcopy() - - doctree = self.env.tocs[indexname].deepcopy() - - toctrees = [] - if "includehidden" not in kwargs: - kwargs["includehidden"] = True +def get_nonroot_toctree( + app: Sphinx, pagename: str, ancestorname: str, toctree, **kwargs +): + """Get the partial TocTree (rooted at `ancestorname`) that dominates `pagename`. + + Parameters: + app : Sphinx app. + pagename : Name of the current page (as Sphinx knows it; i.e., its relative path + from the documentation root). + ancestorname : Name of a page that dominates `pagename` and that will serve as the + root of the TocTree fragment. + toctree : A Sphinx TocTree object. Since this is always needed when finding the + ancestorname (see _get_ancestor_pagename), it's more efficient to pass it here to + re-use it. + kwargs : passed to the Sphinx `toctree` template function. + + This is similar to `context["toctree"](**kwargs)` (AKA `toctree(**kwargs)` within a + Jinja template), or `TocTree.get_toctree_for()`, which always uses the "root" + doctree (i.e., `doctree = self.env.get_doctree(self.env.config.root_doc)`). + """ + kwargs.setdefault("collapse", True) if "maxdepth" not in kwargs or not kwargs["maxdepth"]: kwargs["maxdepth"] = 0 - else: - kwargs["maxdepth"] = int(kwargs["maxdepth"]) - kwargs["collapse"] = collapse - - # TODO: use `doctree.findall(addnodes.toctree)` once docutils min version >=0.18.1 - for toctreenode in traverse_or_findall(doctree, addnodes.toctree): - toctree = self.resolve(docname, builder, toctreenode, prune=True, **kwargs) - if toctree: - toctrees.append(toctree) + kwargs["maxdepth"] = int(kwargs["maxdepth"]) + # starting from ancestor page, recursively parse `toctree::` elements + ancestor_doctree = toctree.env.tocs[ancestorname].deepcopy() + toctrees = [] + + # for each `toctree::` directive in the ancestor page... + for toctree_node in traverse_or_findall(ancestor_doctree, TocTreeNodeClass): + # TODO: ↑↑↑↑↑↑ use `ancestor_doctree.findall(TocTreeNodeClass)` ↑↑↑↑↑↑ + # once docutils min version >=0.18.1 + + # ... resolve that `toctree::` (recursively get children, prune, collapse, etc) + resolved_toctree = toctree.resolve( + docname=pagename, + builder=app.builder, + toctree=toctree_node, + **kwargs, + ) + # ... keep the non-empty ones + if resolved_toctree: + toctrees.append(resolved_toctree) if not toctrees: return None + # ... and merge them into a single entity result = toctrees[0] - for toctree in toctrees[1:]: - result.extend(toctree.children) + for resolved_toctree in toctrees[1:]: + result.extend(resolved_toctree.children) return result - - -def index_toctree( - app: Sphinx, pagename: str, startdepth: int, collapse: bool = True, **kwargs -): - """Returns the "local" (starting at `startdepth`) TOC tree containing the current page, rendered as HTML bullet lists. - - This is the equivalent of `context["toctree"](**kwargs)` in sphinx - templating, but using the startdepth-local instead of global TOC tree. - """ - # this is a variant of the function stored in `context["toctree"]`, which is - # defined as `lambda **kwargs: self._get_local_toctree(pagename, **kwargs)` - # with `self` being the HMTLBuilder and the `_get_local_toctree` basically - # returning: - # return self.render_partial(TocTree(self.env).get_toctree_for( - # pagename, self, collapse, **kwargs))['fragment'] - - if "includehidden" not in kwargs: - kwargs["includehidden"] = False - if kwargs.get("maxdepth") == "": - kwargs.pop("maxdepth") - - toctree = TocTree(app.env) - if sphinx.version_info[:2] >= (7, 2): - from sphinx.environment.adapters.toctree import _get_toctree_ancestors - - ancestors = [*_get_toctree_ancestors(app.env.toctree_includes, pagename)] - else: - ancestors = toctree.get_toctree_ancestors(pagename) - try: - indexname = ancestors[-startdepth] - except IndexError: - # eg for index.rst, but also special pages such as genindex, py-modindex, search - # those pages don't have a "current" element in the toctree, so we can - # directly return an empty string instead of using the default sphinx - # toctree.get_toctree_for(pagename, app.builder, collapse, **kwargs) - return "" - - toctree_element = get_local_toctree_for( - toctree, indexname, pagename, app.builder, collapse, **kwargs - ) - return app.builder.render_partial(toctree_element)["fragment"] diff --git a/src/pydata_sphinx_theme/utils.py b/src/pydata_sphinx_theme/utils.py index d56b71430..7b834f987 100644 --- a/src/pydata_sphinx_theme/utils.py +++ b/src/pydata_sphinx_theme/utils.py @@ -1,11 +1,13 @@ """General helpers for the management of config parameters.""" +import copy +import os import re -from typing import Any, Dict, Iterator +from typing import Any, Dict, Iterator, List, Optional, Union from docutils.nodes import Node from sphinx.application import Sphinx -from sphinx.util import logging +from sphinx.util import logging, matching def get_theme_options_dict(app: Sphinx) -> Dict[str, Any]: @@ -58,3 +60,114 @@ def maybe_warn(app: Sphinx, msg, *args, **kwargs): should_warn = theme_options.get("surface_warnings", False) if should_warn: SPHINX_LOGGER.warning(msg, *args, **kwargs) + else: + SPHINX_LOGGER.info(msg, *args, **kwargs) + + +def set_secondary_sidebar_items( + app: Sphinx, pagename: str, templatename: str, context, doctree +) -> None: + """Set the secondary sidebar items to render for the given pagename.""" + if "theme_secondary_sidebar_items" in context: + templates = context["theme_secondary_sidebar_items"] + if isinstance(templates, dict): + templates = _get_matching_sidebar_items(pagename, templates) + + context["secondary_sidebar_items"] = _update_and_remove_templates( + app, + context, + templates, + "theme_secondary_sidebar_items", + ) + + +def _update_and_remove_templates( + app: Sphinx, + context: Dict[str, Any], + templates: Union[List, str], + section: str, + templates_skip_empty_check: Optional[List[str]] = None, +) -> List[str]: + """Update templates to include html suffix if needed; remove templates which render empty. + + Args: + app: Sphinx application passed to the html page context + context: The html page context; dictionary of values passed to the templating engine + templates: A list of template names, or a string of comma separated template names + section: Name of the template section where the templates are to be rendered. Valid + section names include any of the ``sphinx`` or ``html_theme_options`` that take templates + or lists of templates as arguments, for example: ``theme_navbar_start``, + ``theme_primary_sidebar_end``, ``theme_secondary_sidebar_items``, ``sidebars``, etc. For + a complete list of valid section names, see the source for + :py:func:`pydata_sphinx_theme.update_and_remove_templates` and + :py:func:`pydata_sphinx_theme.utils.set_secondary_sidebar_items`, both of which call + this function. + templates_skip_empty_check: Names of any templates which should never be removed from the list + of filtered templates returned by this function. These templates aren't checked if they + render empty, which can save time if the template is slow to render. + + Returns: + A list of template names (including '.html' suffix) to render into the section + """ + if templates_skip_empty_check is None: + templates_skip_empty_check = [] + + # Break apart `,` separated strings so we can use , in the defaults + if isinstance(templates, str): + templates = [template.strip() for template in templates.split(",")] + + # Add `.html` to templates with no suffix + suffixed_templates = [] + for template in templates: + if os.path.splitext(template)[1]: + suffixed_templates.append(template) + else: + suffixed_templates.append(f"{template}.html") + + ctx = copy.copy(context) + ctx.update({section: suffixed_templates}) + + # Check whether the template renders to an empty string; remove if this is the case + # Skip templates that are slow to render with templates_skip_empty_check + filtered_templates = [] + for template in suffixed_templates: + if any(template.endswith(item) for item in templates_skip_empty_check): + filtered_templates.append(template) + else: + rendered = app.builder.templates.render(template, ctx) + if len(rendered.strip()) != 0: + filtered_templates.append(template) + + return filtered_templates + + +def _get_matching_sidebar_items( + pagename: str, sidebars: Dict[str, List[str]] +) -> List[str]: + """Get the matching sidebar templates to render for the given pagename. + + If a page matches more than one pattern, a warning is emitted, and the templates for the + last matching pattern are used. + + This function was adapted from sphinx.builders.html.StandaloneHTMLBuilder.add_sidebars. + """ + matched = None + secondary_sidebar_items = [] + for pattern, sidebar_items in sidebars.items(): + if matching.patmatch(pagename, pattern): + if matched and _has_wildcard(pattern) and _has_wildcard(matched): + SPHINX_LOGGER.warning( + f"Page {pagename} matches two wildcard patterns in secondary_sidebar_items: {matched} and {pattern}" + ), + + matched = pattern + secondary_sidebar_items = sidebar_items + return secondary_sidebar_items + + +def _has_wildcard(pattern: str) -> bool: + """Check whether the pattern contains a wildcard. + + Taken from sphinx.builders.StandaloneHTMLBuilder.add_sidebars. + """ + return any(char in pattern for char in "*?[") diff --git a/tests/sites/sidebars/index.rst b/tests/sites/sidebars/index.rst index d5596838d..d4318a7e5 100644 --- a/tests/sites/sidebars/index.rst +++ b/tests/sites/sidebars/index.rst @@ -11,3 +11,8 @@ Sidebar depth variations :caption: Caption 2 section2/index + +Other content +------------- + +This is some other content. diff --git a/tests/sites/sidebars/section1/index.rst b/tests/sites/sidebars/section1/index.rst index 9c9eeb89d..71d90df86 100644 --- a/tests/sites/sidebars/section1/index.rst +++ b/tests/sites/sidebars/section1/index.rst @@ -6,3 +6,8 @@ Section 1 index subsection1/index page2 + +Other Content +------------- + +This is some other content diff --git a/tests/sites/sidebars/section1/subsection1/page2.rst b/tests/sites/sidebars/section1/subsection1/page2.rst index c229b0796..9291751ae 100644 --- a/tests/sites/sidebars/section1/subsection1/page2.rst +++ b/tests/sites/sidebars/section1/subsection1/page2.rst @@ -1,2 +1,6 @@ Section 1 sub 1 page 2 ====================== + + +Section A +--------- diff --git a/tests/sites/sidebars/section2/index.rst b/tests/sites/sidebars/section2/index.rst index 942cb0e8f..94ab69deb 100644 --- a/tests/sites/sidebars/section2/index.rst +++ b/tests/sites/sidebars/section2/index.rst @@ -5,3 +5,9 @@ Section 2 index page1 https://google.com + + +Other Content +------------- + +This is some other content diff --git a/tests/test_a11y.py b/tests/test_a11y.py index fadf30c27..d9d9dbbfb 100644 --- a/tests/test_a11y.py +++ b/tests/test_a11y.py @@ -8,8 +8,6 @@ import pytest -from .utils.pretty_axe_results import pretty_axe_results - # Using importorskip to ensure these tests are only loaded if Playwright is installed. playwright = pytest.importorskip("playwright") from playwright.sync_api import Page, expect # noqa: E402 @@ -72,26 +70,75 @@ def url_base(): process.wait() +def fingerprint_violations(accessibility_page_scan_violations): + """Create a fingerprint of the Axe violations array. + + https://playwright.dev/docs/accessibility-testing#using-snapshots-to-allow-specific-known-issues + """ + return [ + { + "id": violation["id"], + "help": violation["help"], + "helpUrl": violation["helpUrl"], + "targets": [node["target"] for node in violation["nodes"]], + } + for violation in accessibility_page_scan_violations + ] + + @pytest.mark.a11y @pytest.mark.parametrize("theme", ["light", "dark"]) @pytest.mark.parametrize( "url_pathname,selector", [ - ("/examples/kitchen-sink/admonitions.html", "#admonitions"), - ("/examples/kitchen-sink/api.html", "#api-documentation"), + ( + "/examples/kitchen-sink/admonitions.html", + "#admonitions", + ), + ( + "/examples/kitchen-sink/api.html", + "#api-documentation", + ), ("/examples/kitchen-sink/blocks.html", "#blocks"), - ("/examples/kitchen-sink/generic.html", "#generic-items"), - ("/examples/kitchen-sink/images.html", "#images-figures"), + ( + "/examples/kitchen-sink/generic.html", + "#generic-items", + ), + ( + "/examples/kitchen-sink/images.html", + "#images-figures", + ), ("/examples/kitchen-sink/lists.html", "#lists"), - ("/examples/kitchen-sink/structure.html", "#structural-elements"), - ("/examples/kitchen-sink/structure.html", "#structural-elements-2"), + ( + "/examples/kitchen-sink/structure.html", + "#structural-elements", + ), + ( + "/examples/kitchen-sink/structure.html", + "#structural-elements-2", + ), ("/examples/kitchen-sink/tables.html", "#tables"), - ("/examples/kitchen-sink/typography.html", "#typography"), + ( + "/examples/kitchen-sink/typography.html", + "#typography", + ), ("/examples/pydata.html", "#pydata-library-styles"), - ("/user_guide/theme-elements.html", "#theme-specific-elements"), - ("/user_guide/web-components.html", "#sphinx-design-components"), - ("/user_guide/extending.html", "#extending-the-theme"), - ("/user_guide/styling.html", "#theme-variables-and-css"), + ( + "/user_guide/theme-elements.html", + "#theme-specific-elements", + ), + ( + "/user_guide/web-components.html", + "#sphinx-design-components", + ), + ( + "/user_guide/extending.html", + "#extending-the-theme", + ), + ( + "/user_guide/styling.html", + "#theme-variables-and-css", + ), # Using one of the simplest pages on the site, select the whole page for # testing in order to effectively test repeated website elements like # nav, sidebars, breadcrumbs, footer @@ -99,7 +146,12 @@ def url_base(): ], ) def test_axe_core( - theme: str, url_base: str, url_pathname: str, selector: str, page: Page + data_regression, + theme: str, + url_base: str, + url_pathname: str, + selector: str, + page: Page, ): """Should have no Axe-core violations at the provided theme and page section.""" # Load the page at the provided path @@ -118,8 +170,8 @@ def test_axe_core( # the PyData Sphinx Theme documentation website.) results = page.evaluate("axe.run()" if selector == "" else f"axe.run('{selector}')") - # Expect Axe-core to have found 0 accessibility violations - assert len(results["violations"]) == 0, pretty_axe_results(results, selector) + # Check found violations against known violations that we do not plan to fix + data_regression.check(fingerprint_violations(results["violations"])) def test_version_switcher_highlighting(page: Page, url_base: str) -> None: diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_admonitions_html__admonitions_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_admonitions_html__admonitions_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_admonitions_html__admonitions_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_admonitions_html__admonitions_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_admonitions_html__admonitions_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_admonitions_html__admonitions_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_api_html__api_documentation_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_api_html__api_documentation_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_api_html__api_documentation_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_api_html__api_documentation_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_api_html__api_documentation_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_api_html__api_documentation_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_blocks_html__blocks_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_blocks_html__blocks_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_blocks_html__blocks_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_blocks_html__blocks_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_blocks_html__blocks_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_blocks_html__blocks_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_generic_html__generic_items_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_generic_html__generic_items_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_generic_html__generic_items_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_generic_html__generic_items_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_generic_html__generic_items_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_generic_html__generic_items_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_images_html__images_figures_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_images_html__images_figures_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_images_html__images_figures_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_images_html__images_figures_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_images_html__images_figures_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_images_html__images_figures_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_lists_html__lists_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_lists_html__lists_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_lists_html__lists_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_lists_html__lists_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_lists_html__lists_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_lists_html__lists_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_2_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_2_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_2_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_2_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_2_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_2_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_structure_html__structural_elements_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_tables_html__tables_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_tables_html__tables_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_tables_html__tables_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_tables_html__tables_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_tables_html__tables_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_tables_html__tables_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_typography_html__typography_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_typography_html__typography_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_typography_html__typography_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_typography_html__typography_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_typography_html__typography_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_kitchen_sink_typography_html__typography_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__examples_pydata_html__pydata_library_styles_dark_.yml b/tests/test_a11y/test_axe_core_chromium__examples_pydata_html__pydata_library_styles_dark_.yml new file mode 100644 index 000000000..b84d7335f --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_pydata_html__pydata_library_styles_dark_.yml @@ -0,0 +1,5 @@ +- help: Table header text should not be empty + helpUrl: https://dequeuniversity.com/rules/axe/4.6/empty-table-header?application=axeAPI + id: empty-table-header + targets: + - - thead > tr > th:nth-child(1) diff --git a/tests/test_a11y/test_axe_core_chromium__examples_pydata_html__pydata_library_styles_light_.yml b/tests/test_a11y/test_axe_core_chromium__examples_pydata_html__pydata_library_styles_light_.yml new file mode 100644 index 000000000..b84d7335f --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__examples_pydata_html__pydata_library_styles_light_.yml @@ -0,0 +1,5 @@ +- help: Table header text should not be empty + helpUrl: https://dequeuniversity.com/rules/axe/4.6/empty-table-header?application=axeAPI + id: empty-table-header + targets: + - - thead > tr > th:nth-child(1) diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_extending_html__extending_the_theme_dark_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_extending_html__extending_the_theme_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_extending_html__extending_the_theme_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_extending_html__extending_the_theme_light_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_extending_html__extending_the_theme_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_extending_html__extending_the_theme_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_page_toc_html__dark_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_page_toc_html__dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_page_toc_html__dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_page_toc_html__light_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_page_toc_html__light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_page_toc_html__light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_styling_html__theme_variables_and_css_dark_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_styling_html__theme_variables_and_css_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_styling_html__theme_variables_and_css_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_styling_html__theme_variables_and_css_light_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_styling_html__theme_variables_and_css_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_styling_html__theme_variables_and_css_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_theme_elements_html__theme_specific_elements_dark_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_theme_elements_html__theme_specific_elements_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_theme_elements_html__theme_specific_elements_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_theme_elements_html__theme_specific_elements_light_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_theme_elements_html__theme_specific_elements_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_theme_elements_html__theme_specific_elements_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_web_components_html__sphinx_design_components_dark_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_web_components_html__sphinx_design_components_dark_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_web_components_html__sphinx_design_components_dark_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_a11y/test_axe_core_chromium__user_guide_web_components_html__sphinx_design_components_light_.yml b/tests/test_a11y/test_axe_core_chromium__user_guide_web_components_html__sphinx_design_components_light_.yml new file mode 100644 index 000000000..fe51488c7 --- /dev/null +++ b/tests/test_a11y/test_axe_core_chromium__user_guide_web_components_html__sphinx_design_components_light_.yml @@ -0,0 +1 @@ +[] diff --git a/tests/test_build.py b/tests/test_build.py index 1815bcc93..60c95e308 100644 --- a/tests/test_build.py +++ b/tests/test_build.py @@ -307,6 +307,13 @@ def test_logo_template_rejected(sphinx_build_factory) -> None: sphinx_build_factory("base", confoverrides=confoverrides).build() +def test_sticky_header(sphinx_build_factory): + """Regression test, see #1630. Sticky header should be direct descendant of body.""" + sphinx_build = sphinx_build_factory("test_navbar_no_in_page_headers").build() + index_html = sphinx_build.html_tree("index.html") + assert index_html.select_one("body > .bd-header") + + @pytest.mark.parametrize( "align,klass", [ @@ -964,7 +971,6 @@ def test_translations(sphinx_build_factory) -> None: index = sphinx_build.html_tree("section1/index.html") sidebar_primary = index.select(".bd-sidebar-primary")[0] - assert "Navigation du site" in str(sidebar_primary) assert "Navigation de la section" in str(sidebar_primary) sidebar_secondary = index.select(".bd-sidebar-secondary")[0] @@ -986,3 +992,184 @@ def test_translations(sphinx_build_factory) -> None: # Search bar # TODO: Add translations where there are english phrases below assert "Search the docs" in str(index.select(".bd-search")[0]) + + +def test_render_secondary_sidebar_list(sphinx_build_factory) -> None: + """Test that the secondary sidebar can be built with a list of templates.""" + confoverrides = { + "html_context": { + "github_user": "pydata", + "github_repo": "pydata-sphinx-theme", + "github_version": "main", + }, + "html_theme_options": { + "use_edit_page_button": True, + "secondary_sidebar_items": ["page-toc", "edit-this-page"], + }, + } + sphinx_build = sphinx_build_factory("sidebars", confoverrides=confoverrides) + # Basic build with defaults + sphinx_build.build() + + # Check that the page-toc template gets rendered + assert sphinx_build.html_tree("index.html").select("div.page-toc") + assert sphinx_build.html_tree("section1/index.html").select("div.page-toc") + assert sphinx_build.html_tree("section2/index.html").select("div.page-toc") + + # Check that the edit-this-page template gets rendered + assert sphinx_build.html_tree("index.html").select("div.editthispage") + assert sphinx_build.html_tree("section1/index.html").select("div.editthispage") + assert sphinx_build.html_tree("section2/index.html").select("div.editthispage") + + # Check that sourcelink is not rendered + assert not sphinx_build.html_tree("index.html").select("div.sourcelink") + assert not sphinx_build.html_tree("section1/index.html").select("div.sourcelink") + assert not sphinx_build.html_tree("section2/index.html").select("div.sourcelink") + + +def test_render_secondary_sidebar_dict(sphinx_build_factory) -> None: + """Test that the secondary sidebar can be built with a dict of templates.""" + confoverrides = { + "html_context": { + "github_user": "pydata", + "github_repo": "pydata-sphinx-theme", + "github_version": "main", + }, + "html_theme_options": { + **COMMON_CONF_OVERRIDES, + "use_edit_page_button": True, + "secondary_sidebar_items": { + "**": ["page-toc", "edit-this-page"], + "section1/index": [], + "section2/index": ["sourcelink"], + }, + }, + } + sphinx_build = sphinx_build_factory("sidebars", confoverrides=confoverrides) + # Basic build with defaults + sphinx_build.build() + + # Check that the page-toc template gets rendered + # (but not for section1/index or section2/*) + assert sphinx_build.html_tree("index.html").select("div.page-toc") + assert not sphinx_build.html_tree("section1/index.html").select("div.page-toc") + assert not sphinx_build.html_tree("section2/index.html").select("div.page-toc") + + # Check that the edit-this-page template gets rendered + # (but not for section1/index or section2/*) + assert sphinx_build.html_tree("index.html").select("div.editthispage") + assert not sphinx_build.html_tree("section1/index.html").select("div.editthispage") + assert not sphinx_build.html_tree("section2/index.html").select("div.editthispage") + + # Check that sourcelink is only rendered for section2/* + assert not sphinx_build.html_tree("index.html").select("div.sourcelink") + assert not sphinx_build.html_tree("section1/index.html").select("div.sourcelink") + assert sphinx_build.html_tree("section2/index.html").select("div.sourcelink") + + +def test_render_secondary_sidebar_dict_glob_subdir(sphinx_build_factory) -> None: + """Test that the secondary sidebar can be built with a dict of templates that globs a subdir.""" + confoverrides = { + "html_context": { + "github_user": "pydata", + "github_repo": "pydata-sphinx-theme", + "github_version": "main", + }, + "html_theme_options": { + **COMMON_CONF_OVERRIDES, + "use_edit_page_button": True, + "secondary_sidebar_items": { + "section1/index": [], + "section2/*": ["sourcelink"], + }, + }, + } + sphinx_build = sphinx_build_factory("sidebars", confoverrides=confoverrides) + # Basic build with defaults + sphinx_build.build() + + # Check that the no page-toc template gets rendered + assert not sphinx_build.html_tree("section1/index.html").select("div.page-toc") + assert not sphinx_build.html_tree("section2/index.html").select("div.page-toc") + assert not sphinx_build.html_tree("section2/page1.html").select("div.page-toc") + + # Check that no edit-this-page template gets rendered + assert not sphinx_build.html_tree("section1/index.html").select("div.editthispage") + assert not sphinx_build.html_tree("section2/index.html").select("div.editthispage") + assert not sphinx_build.html_tree("section2/page1.html").select("div.editthispage") + + # Check that sourcelink is only rendered for section2/* + assert not sphinx_build.html_tree("section1/index.html").select("div.sourcelink") + assert sphinx_build.html_tree("section2/index.html").select("div.sourcelink") + assert sphinx_build.html_tree("section2/page1.html").select("div.sourcelink") + + +def test_render_secondary_sidebar_dict_multiple_glob_matches( + sphinx_build_factory, +) -> None: + """Test that the secondary sidebar builds with a template dict with two conflicting globs. + + The last specified glob pattern should win, but a warning should be emitted with the + offending pattern and affected pagenames. + """ + confoverrides = { + "html_context": { + "github_user": "pydata", + "github_repo": "pydata-sphinx-theme", + "github_version": "main", + }, + "html_theme_options": { + **COMMON_CONF_OVERRIDES, + "use_edit_page_button": True, + "secondary_sidebar_items": { + "**": [ + "page-toc", + "edit-this-page", + ], # <-- Some pages match both patterns + "section1/index": [], + "section2/*": ["sourcelink"], # <-- Some pages match both patterns + }, + }, + } + sphinx_build = sphinx_build_factory( + "sidebars", + confoverrides=confoverrides, + ) + # Basic build with defaults + sphinx_build.build(no_warning=False) + + # Check that the proper warnings are emitted for the affected pages + for page in ["section2/index", "section2/page1"]: + assert ( + f"WARNING: Page {page} matches two wildcard patterns " + "in secondary_sidebar_items: ** and section2/*" + ) in sphinx_build.warnings + + # Check that the page-toc template gets rendered + # (but not for section1/index or section2/*) + assert sphinx_build.html_tree("index.html").select("div.page-toc") + assert not sphinx_build.html_tree("section1/index.html").select("div.page-toc") + assert not sphinx_build.html_tree("section2/index.html").select("div.page-toc") + assert not sphinx_build.html_tree("section2/page1.html").select("div.page-toc") + + # Check that the edit-this-page template gets rendered + # (but not for section1/index or section2/*) + assert sphinx_build.html_tree("index.html").select("div.editthispage") + assert not sphinx_build.html_tree("section1/index.html").select("div.editthispage") + assert not sphinx_build.html_tree("section2/index.html").select("div.editthispage") + assert not sphinx_build.html_tree("section2/page1.html").select("div.editthispage") + + # Check that sourcelink is only rendered for section2/* + assert not sphinx_build.html_tree("index.html").select("div.sourcelink") + assert not sphinx_build.html_tree("section1/index.html").select("div.sourcelink") + assert sphinx_build.html_tree("section2/index.html").select("div.sourcelink") + assert sphinx_build.html_tree("section2/page1.html").select("div.sourcelink") + + +def test_role_main_for_search_highlights(sphinx_build_factory): + """Sphinx searchtools.js looks for [role="main"], so make sure it's there. + + This is a regression test. See #1676. + """ + sphinx_build = sphinx_build_factory("base").build() + assert sphinx_build.html_tree("index.html").select_one('[role="main"]') diff --git a/tests/test_build/math_header_item.html b/tests/test_build/math_header_item.html index 0a7bebd93..aa8751db0 100644 --- a/tests/test_build/math_header_item.html +++ b/tests/test_build/math_header_item.html @@ -1,4 +1,4 @@ -
  • +
  • Page diff --git a/tests/test_build/navbar_ix.html b/tests/test_build/navbar_ix.html index 5b2de048a..00fcdcce7 100644 --- a/tests/test_build/navbar_ix.html +++ b/tests/test_build/navbar_ix.html @@ -1,16 +1,13 @@