remove deprecated configs and associated code/tests (#1698)

deprecations

Author: drammock

docs/conf.py

@@ -188,9 +188,7 @@
         "json_url": json_url,
         "version_match": version_match,
     },
-    "navigation_with_keys": False,
     # "back_to_top_button": False,
-    # "search_bar_position": "navbar",  # TODO: Deprecated - remove in future version
 }
 
 html_sidebars = {

docs/user_guide/branding.rst

@@ -142,48 +142,6 @@ this assumption by supplying both ``text`` and ``alt_text``).
 Add favicons
 ============
 
-.. deprecated:: 0.15
-
-   Support for complex and multiple favicons will be dropped in version 0.15. Instead, use the `sphinx-favicon <https://sphinx-favicon.readthedocs.io/en/stable/>`__ extension.
-   It provides the same functionality using more flexible parameters.
-
-
 ``pydata_sphinx_theme`` supports the `standard sphinx favicon configuration <https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_favicon>`_, using ``html_favicon``.
-
-Additionally, you may add any number of browser- or device-specific favicons of any size.
-To do so, use the ``html_theme_options["favicons"]`` configuration key.
-The only required argument is ``href``, which can be either an absolute URL (beginning with ``http``) or a local path relative to your ``html_static_path``.
-In addition, you may specify a size with ``sizes``, specify a ``rel`` value, and specify a ``color``.
-See `this blog post on SVG favicons for more information <https://medium.com/swlh/are-you-using-svg-favicons-yet-a-guide-for-modern-browsers-836a6aace3df>`_.
-
-For example, below we define three extra favicons of different sizes and ``rel`` types, and one with a specific color.
-
-.. code-block:: python
-
-   html_theme_options = {
-      "favicons": [
-         {
-            "rel": "icon",
-            "sizes": "16x16",
-            "href": "https://secure.example.com/favicon/favicon-16x16.png",
-         },
-         {
-            "rel": "icon",
-            "sizes": "32x32",
-            "href": "favicon-32x32.png",
-         },
-         {
-            "rel": "apple-touch-icon",
-            "sizes": "180x180",
-            "href": "apple-touch-icon-180x180.png",
-            "color": "#000000",
-         },
-      ]
-   }
-
-``pydata_sphinx_theme`` will add ``link`` tags to your document's ``head``
-section, following this pattern:
-
-.. code-block:: html+jinja
-
-   <link rel="{{ favicon.rel }}" sizes="{{ favicon.sizes }}" href="{{ favicon.href }}" color="{{ favicon.color }}">
+Support for complex and multiple favicons was dropped in version 0.15.3. Instead, use the `sphinx-favicon <https://sphinx-favicon.readthedocs.io/en/stable/>`__ extension.
+It provides the same functionality using more flexible parameters.

src/pydata_sphinx_theme/__init__.py

@@ -25,41 +25,6 @@ def update_config(app):
     theme_options = utils.get_theme_options_dict(app)
     warning = partial(utils.maybe_warn, app)
 
-    # TODO: deprecation; remove after 0.14 release
-    if theme_options.get("logo_text"):
-        logo = theme_options.get("logo", {})
-        logo["text"] = theme_options.get("logo_text")
-        theme_options["logo"] = logo
-        warning(
-            "The configuration `logo_text` is deprecated. Use `'logo': {'text': }`."
-        )
-
-    # TODO: DEPRECATE after 0.14
-    if theme_options.get("footer_items"):
-        theme_options["footer_start"] = theme_options.get("footer_items")
-        warning(
-            "`footer_items` is deprecated. Use `footer_start` or `footer_end` instead."
-        )
-
-    # TODO: DEPRECATE after v0.15
-    if theme_options.get("favicons"):
-        warning(
-            "The configuration `favicons` is deprecated. "
-            "Use the sphinx-favicon extension instead."
-        )
-
-    # TODO: in 0.15, set the default navigation_with_keys value to False and remove this deprecation notice
-    if theme_options.get("navigation_with_keys", None) is None:
-        warning(
-            "The default value for `navigation_with_keys` will change to `False` in "
-            "the next release. If you wish to preserve the old behavior for your site, "
-            "set `navigation_with_keys=True` in the `html_theme_options` dict in your "
-            "`conf.py` file. Be aware that `navigation_with_keys = True` has negative "
-            "accessibility implications: "
-            "https://github.com/pydata/pydata-sphinx-theme/issues/1492"
-        )
-        theme_options["navigation_with_keys"] = False
-
     # Validate icon links
     if not isinstance(theme_options.get("icon_links", []), list):
         raise ExtensionError(
@@ -228,18 +193,6 @@ def update_and_remove_templates(
             if asset_path == theme_css_name:
                 del context["css_files"][i]
                 break
-    # Add links for favicons in the topbar
-    for favicon in context.get("theme_favicons", []):
-        icon_type = Path(favicon["href"]).suffix.strip(".")
-        opts = {
-            "rel": favicon.get("rel", "icon"),
-            "sizes": favicon.get("sizes", "16x16"),
-            "type": f"image/{icon_type}",
-        }
-        if "color" in favicon:
-            opts["color"] = favicon["color"]
-        # Sphinx will auto-resolve href if it's a local file
-        app.add_css_file(favicon["href"], **opts)
 
     # Add metadata to DOCUMENTATION_OPTIONS so that we can re-use later
     # Pagename to current page

src/pydata_sphinx_theme/theme/pydata_sphinx_theme/theme.conf

@@ -19,11 +19,9 @@ twitter_url =
 icon_links_label = Icon Links
 icon_links =
 analytics =
-favicons =
 show_prev_next = True
 search_bar_text = Search the docs ...
-search_bar_position = sidebar
-navigation_with_keys =
+navigation_with_keys = False
 collapse_navigation = False
 navigation_depth = 4
 show_nav_level = 1
@@ -55,6 +53,3 @@ footer_end = theme-version
 secondary_sidebar_items = page-toc, edit-this-page, sourcelink
 show_version_warning_banner = False
 announcement =
-
-# DEPRECATE after 0.14
-footer_items =

tests/sites/base/conf.py

@@ -20,6 +20,4 @@
 html_sourcelink_suffix = ""
 
 # Base options, we can add other key/vals later
-html_theme_options = {"navigation_with_keys": False}
-
 html_sidebars = {"section1/index": ["sidebar-nav-bs.html"]}

tests/sites/deprecated/conf.py

@@ -21,27 +21,7 @@
 
 # Base options, we can add other key/vals later
 html_theme_options = {
-    "search_bar_position": "navbar",
     "surface_warnings": True,
-    "logo_text": "DOCS",
-    "footer_items": ["page-toc.html"],
-    "favicons": [
-        {
-            "rel": "icon",
-            "sizes": "16x16",
-            "href": "https://secure.example.com/favicon/favicon-16x16.png",
-        },
-        {
-            "rel": "icon",
-            "sizes": "32x32",
-            "href": "favicon-32x32.png",
-        },
-        {
-            "rel": "apple-touch-icon",
-            "sizes": "180x180",
-            "href": "apple-touch-icon-180x180.png",
-        },
-    ],
 }
 
 html_sidebars = {"section1/index": ["sidebar-nav-bs.html"]}

tests/sites/sidebars/conf.py

@@ -11,5 +11,3 @@
 # -- General configuration ---------------------------------------------------
 
 html_theme = "pydata_sphinx_theme"
-
-html_theme_options = {"navigation_with_keys": False}

tests/sites/test_included_toc/conf.py

@@ -13,5 +13,3 @@
 # -- Options for HTML output -------------------------------------------------
 
 html_theme = "pydata_sphinx_theme"
-
-html_theme_options = {"navigation_with_keys": False}

tests/sites/test_navbar_no_in_page_headers/conf.py

@@ -14,5 +14,3 @@
 
 html_copy_source = True
 html_sourcelink_suffix = ""
-
-html_theme_options = {"navigation_with_keys": False}