Highlights
We decided to deprecate a few things to pave the way towards a more
stable code base, bringing us closer to a v1.
- Selection and rendering options are now combined into a single
options
key. Using the old keys will emit a deprecation warning. - The
BaseCollector
andBaseRenderer
classes are deprecated in favor
ofBaseHandler
, which merges their functionality. Using the old
classes will emit a deprecation warning.
New versions of the Python handler and the legacy Python handler
were also released in coordination with mkdocstrings 0.19.
See their respective changelogs: python, python-legacy.
Most notably, the Python handler gained the members
and filters
options
that prevented many users to switch to it.
mkdocstrings stopped depending directly on the legacy Python handler.
It means you now have to explicitely depend on it, directly or through
the extra provided by mkdocstrings, if you want to continue using it.
Packaging / Dependencies
- Stop depending directly on mkdocstrings-python-legacy (9055d58 by Timothée Mazzucotelli). Issue #376
Features
- Pass config file path to handlers (cccebc4 by Timothée Mazzucotelli). Issue #311, PR #425
Code Refactoring
- Support options / deprecated options mix-up (7c71f26 by Timothée Mazzucotelli).
- Deprecate watch feature in favor of MkDocs' built-in one (c20022e by Timothée Mazzucotelli).
- Log relative template paths if possible, instead of absolute (91f5f83 by Timothée Mazzucotelli).
- Deprecate
selection
andrendering
YAML keys (3335310 by Timothée Mazzucotelli). PR #420 - Deprecate
BaseCollector
andBaseRenderer
(eb822cb by Timothée Mazzucotelli). PR #413