Flamingo

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

Bugfixes
~~~~~~~~

* server: fix compatibility issues with aiohttp 3.8

* core: data model: NOT, OR, AND: fix compatibility problems between different
python versions

* plugins: SphinxThemes: pin dependencies to a compatible versions

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

Changes
~~~~~~~

* shell: replace IPython with rlpython
* server: add a aiohttp-json-rpc replacement
* server: update aiohttp dependency
* server: set default watcher refresh interval to 1 second
* plugins: SphinxThemes: add support for multiple toctree captions
* plugins: SphinxThemes: add support for extra stylesheets and scripts
* plugins: setup ``flamingo.plugins.rstTable``
* doc: use official ReadTheDocs theme instead of fork

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

This release brings support for Shpinx themes, reStructuredText includes and
various bugfixes and also drops support for Python 3.5


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

* change range of supported Python versions to Python>3.5

* core: utils: html: extract_section_by_title got renamed to
get_section_to_title

* plugins: Menu: Menu uses its own plugin namespace for resolving paths
instead of the settings namespace now

* all templates now have to use ``context.plugins.Menu.menu.main`` instead
of ``context.settings.MENU.main``


Changes
~~~~~~~

* server: better support for ``related_paths`` keyword

* server: add ``--shutdown-timeout``

* default in set to ``0.0`` (this fixes previous shutdown problems)

* plugins: add ``plugins.SphinxThemes``
* plugins: add ``plugins.rstInclude``
* plugins: Feeds: error messages are more human readable now

* plugins: reStructuredText: fix wrong line numbers in warnings and
error messages

* plugins: Photoswipe: add support for SVGs
* plugins: Thumbnails: add support for SVGs


Bugfixes
~~~~~~~~

* plugins: rstImage: fix name clashes in meta data
* plugins: Feeds: fix link resolving in feed items
* plugins: reStructuredText: Container directive: fix namespace problems

* plugins: Thumbnails: fix thumbnail output paths

* The previous naming scheme ``$FILE_NAME.thumb.$EXTENSION`` was not unique
and lead to overriding of thumbnail. The new naming scheme is
``$FILE_NAME.thumb.$HASH.$EXTENSION``.

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

This release brings a changes and bugfixes for ``plugins.Time``


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

* plugins: Time: add comparison between ``datetime.date`` and
``datetime.datetime`` objects

* If a value in ``content['date']`` comes without a time string,
``datetime.datetime.min.time()`` gets used for comparisons


Bugfixes
~~~~~~~~

* plugins: Time: wrong implicit type casting of time object

* Previously it could happen that ``datetime.datetime`` objects got
mistakenly type casted to ``datetime.date`` objects

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

This release brings bugfixes, performance improvements and long anticipated
development features like directory-listing and configurable directory-indexing


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

* core: set ``content['output']`` to ``/dev/null`` when ``output``
and ``path`` are not set

* This saves loop iterations when rendering output

* server: consolidate command line args

* Previously the command line used terms like ``--disable-$FEATURE`` which
lead to double negation in code. Also it made it hard to change defaults.

* plugins: Feeds: use ``title`` or ``content_title`` for feed items

* This emulates flamingos behavior on how to search for a content files title

* plugins: reStructuredText: split plugin in multiple modules

* plugins: rstLink: remove obsolete option ``find_name``

* This option never made sense: If you provide a link name, it is obvious
that flamingo don't has to search for one. If you don't provide one,
setting ``find_name=False`` can only result in a crash.

* plugins: remove plugins.rst.rstFile

* Since plugins.rst.rstLink has support for downloadable files, this plugin
is obsolete


Changes
~~~~~~~

* core: data model: Q: skip unnecessary lookups; cache lookups

* This can (depending on your use cases) have a significant impact on your
projects performance

* core: context: add hook template_context_setup

* This makes it possible to inject context changes to any template

* core: context: add ``media_content`` property
* core: plugin manager: add tab completion for shell

* plugins: rstLink: add support for downloads
* server: BuildEnvironment: add api to await rebuilds
* server: share server options live between frontend and backend
* server: ContentExporter: add directory listing
* server: frontend: add better tab- and shortcut handling
* server: add sync variant of ``await_unlock()``

* tests: setup server tests
* tests: add tests for plugins.Git
* tests: add tests for plugins.Thumbnails
* tests: core: settings: add overlay tests
* tests: add tests for plugins.rst.rstLink
* tests: add layer tests


Bugfixes
~~~~~~~~

* core: context: build: run hook ``pre_build`` hook after initial cleanup

* pre build layers were pretty much broken by design before

* server: cli: fix log filtering

* ``--loggers`` was never processed properly

* server: meta data: use overlay data instead of original data
* server: meta data: mask overlay types

* Previously this lead to confusing output in the ``Meta Data`` tab in
flamingo server

* core: types: OverlayObject: fix duplicates in ``__dir__()``

* plugins: reStructuredText: fix caching issues for directives and roles

* Previous versions of the reStructuredText plugin use the reStructuredText
upstreams directive cache, which is fine til you try to overload a
directive twice. This lead to confusing results when running tests.

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

Changes
~~~~~~~

* tests: plugins: Markdown: test image tag rendering


Bugfixes
~~~~~~~~

* core: utils: html: ``process_media_links()``: fix broken media meta data

This fixes broken image tags in Markdown files