Flamingo

-----------------------------------------------------------------------------------------

Changes
~~~~~~~

(none)

Bugfixes
~~~~~~~~

* plugins/Sphinx: Sphinx 7.3.0 has introduced a
`new configuration format <https://github.com/sphinx-doc/sphinx/pull/12265>`__ for themes.
This breaks the way we parse the theme configuration.
For this bugfix release we pin the Sphinx dependency to :code:`<7.3.0` to work around this problem.

------------------------------------------------------------------------------------

Changes
~~~~~~~

* plugins/tags: The :code:`tag` metadata can now be a real `yaml`-list instead of a list string.
* plugins/feeds: A podcast-author can be added to a feeds metadata by setting the
:code:`itunes_author` property in the feed definition.
* plugins/feeds: The HTML content of a feed-entry can be filtered by a function.
This is intended to remove items that should not be included in the feed
(e.g. the actual podcast player for podcasts)
or to only publish a preview of the post.
* Feeds: The :code:`content type` of entries is now set to :code:`HTML`.
This should reduce confusion in some feed readers.
* Feeds: Convert all URLs from relative to absolute.
Feeds should not contain relative URLs. Some feed readers and
podcast clients seem to convert relative URLs into absolute ones. Let's
not rely on that and convert relative URLs into absolute URLs for a.href
and img.src.
* BeautifulSoup: Silence :code:`MarkupResemblesLocatorWarning`.
BS4 now raises a :code:`MarkupResemblesLocatorWarning` every time a content
looks like a path or URL.
In Flamingo this is usually intended and not an user error.
So we silence this warning completely.

Bugfixes
~~~~~~~~

(none)

------------------------------------------------------------------------------------

Changes
~~~~~~~

* plugins/sphinx_themes: Make compatible to Sphinx>=5.02.
* plugins/feeds: Add support for Podcast-Style RSS feeds

Bugfixes
~~~~~~~~

* tests/plugin_git now works with output on systems with other languages than English.
* plugins/feeds: Set attributes that are mandatory for RSS feeds

------------------------------------------------------------------------------------

Changes
~~~~~~~

* jinja2: Make integration compatible to jinja2 > 3.0.0
* tox: It's now possible to run a single test using ``tox -- <testname>``
* Release Workflow: Moved from a ``tox``-based to a ``make``-based workflow.
We can now run ``make sdist`` and ``make _release`` to upload a new dist to pypi.

Breaking Changes
~~~~~~~~~~~~~~~~

* plugins/sphinx_themes: Update Sphinx to 4.5.0 and sphinx_rtd_theme to 1.0.0.
After this change your ``settings.py`` needs to be altered according to
https://github.com/pengutronix/flamingo/commit/4725f2ef94021b4eb49e497109c084a798d989af

--------------------------------------------------------------------------------------

Bugfixes
~~~~~~~~

* plugins: Tags: titles in tag listing pages were fixed

* Previously tag listing pages contained "None" if the template didn't set
a proper title

------------------------------------------------------------------------------------

Breaking Changes
~~~~~~~~~~~~~~~~

* plugins: reStructuredText: document_xform is now disabled by default

* With this option enabled all articles with more than one heading are
structured in sections, and all articles with less than two headings are
not. This caused all sorts of CSS an structuring problems.

Bugfixes
~~~~~~~~

* plugins: SphinxThemes: handling of active menu items was fixed

* Previously the menu was not expanded correctly in all cases