Version 2.0.3 ------------- Released 2022-12-24 - Fix compatibility with ``packaging>=22``. Version 2.0.2 ------------- Released 2021-11-10 - Detect if Sphinx dirhtml builder is generating canonical URLs with ".html" and replace with the correct dir URL. :issue:`47` - ``canonical_url`` config is deprecated. Use Sphinx's built-in ``html_baseurl`` config instead. :pr:`53` - Address deprecations in Jinja 2.0. :pr:`54` Version 2.0.1 ------------- Released 2021-05-20 - Remove workaround for search URLs when using the ``dirhtml`` builder. The issue has been fixed in Sphinx and the workaround was causing the issue again. :issue:`39` - Remove ``html_context["readthedocs_docsearch"]`` for controlling whether Read the Docs' search is used. :issue:`40` - Add an ``ethicalads.html`` sidebar to have Read the Docs always show ads in the sidebar instead of other possible locations. The sidebar is enabled by default at the end of the list. :issue:`41` Version 2.0.0 ------------- Released 2021-05-11 - Drop Python < 3.6. - Update for Jinja 2.0. - Update for Click 8.0. Version 1.2.3 ------------- Released 2020-01-02 - Use built-in :mod:`importlib.metadata` on Python 3.8. :pr:`27` Version 1.2.2 ------------- Released 2019-07-04 - Make the version warning sticky so that it appears when linking to the middle of a document. :issue:`5` - Remove CSS for old ads. Version 1.2.1 ------------- Released 2019-07-29 - Sort versions taken from Read the Docs so that 2.10.x is considered newer than 2.9.x. :issue:`24` Version 1.2.0 ------------- Released 2019-07-26 - Use HTTPS for font URLs in CSS. :pr:`22` - Don't require ``sphinx.ext.autodoc`` to be enabled. - Implement the Jinja directives ``jinja:filters::``, ``jinja:tests::``, and ``jinja:nodes::``. - Generate a table of contents for Jinja filters and tests. - Update the ``babel`` and ``platter`` themes. Version 1.1.4 ------------- Released 2019-01-28 - Store a page's canonical URL in ``html_context["page_canonical_url"]`` rather than overwriting ``canonical_url``, for compatibility with Read the Docs. :pr:`21` Version 1.1.3 ------------- Released 2019-01-28 - Move the Read the Docs search flag to the ``footer`` block to ensure it executes after Read the Docs injects its data. :pr:`20` Version 1.1.2 ------------- Released 2018-09-24 - Strip ".x" placeholder when parsing versions for sidebar. :issue:`7`, :pr:`17` Version 1.1.1 ------------- Released 2018-09-16 - Add configurable ".x" placholder to versions, producing strings like "1.2.x". :issue:`6`, :pr:`12` - Add dependency on "packaging" to support older Sphinx versions. :issue:`9`, :pr:`11` - Backport ``shlex.quote`` for Python 2. :issue:`13`, :pr:`14` Version 1.1.0 ------------- Released 2018-08-28 - Modernize ``click`` theme. The ``.. click:example::`` and ``.. click:run::`` directives used by Click are available and ported to Python 3. - Modernize ``werkzeug`` theme. :pr:`4` - Modernize ``jinja`` theme. Local extensions used by Jinja are not available yet. - Remove theme entry points to make late configuration consistent. The themes are available when ``"pallets_sphinx_themes"`` is added to ``extensions``. - Only run event callbacks added by theme when the theme is actually in use. This allows the package to be installed without interfering with other themes. - Support ``html_context["versions"]`` in the format injected by Read the Docs. - Set ``html_context["readthedocs_docsearch"]`` to opt in to replacing Sphinx's built-in search with Read the Docs' new implementation. - Make version handling more robust for various configurations. - Autodoc skips docstrings that contain the line ``:internal:``. - Autodoc removes lines that start with ``:copyright:`` or ``:license:`` from module docstrings. - Add ``singlehtml_sidebars`` config for Sphinx < 1.8. - Add ``hide-header`` CSS class to hide the page header with ``.. rst-class:: hide-header``. The header is still useable by assistive technology. This is useful for replacing the header with a large logo image. - Disable the sidebar logo on the index page with ``html_theme_options["index_sidebar_logo"] = False``. Version 1.0.1 ------------- Released 2018-04-29 - Work around an issues with search when using the ``dirhtml`` builder. :pr:`3` Version 1.0.0 ------------- Released 2018-04-18 - Major rewrite of CSS and HTML templates to clean up and reduce complexity. Widen columns, improve responsive breakpoints. Currently all themes are available, but only ``pocoo`` and ``flask`` themes are modernized. - Parse ``html_context["versions"]``. These will be rendered in the ``versions.html`` sidebar. When viewing an old version, or the development version, a warning is displayed at the top of each page. - Add a ``ProjectLink`` named tuple. A list of these in ``html_context["project_links"]`` will be rendered in the ``project.html`` sidebar. - Add a ``get_version`` function to ensure a project is installed and get its version information. - Use ``html_context["canonical_url"]`` as a base URL to build a canonical URL link on each page. - Add Sphinx entry points for themes. - Rename from "pocoo-sphinx-themes". See commit `f675bfc`_ for the old themes from the docbuilder. .. _f675bfc: https://github.com/pallets/pallets-sphinx-themes/tree/f675bfc