Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

hawkmoth.ext.transformations and hawkmoth.util.doccompat deprecation #246

Merged
merged 3 commits into from
Sep 11, 2024
Merged

hawkmoth.ext.transformations and hawkmoth.util.doccompat deprecation #246

merged 3 commits into from
Sep 11, 2024

Commits on Sep 11, 2024

  1. extensions: deprecate hawkmoth.ext.transformations and hawkmoth.util.… 

    …doccompat

The introduction of the cautodoc_transformations config option was a
mistake to begin with. The right way forward is the
hawkmoth-process-docstring event. The hawkmoth.ext.transformations
extension was introduced as a temporary solution to not immediately pull
the plug on cautodoc_transformations.

It's time to deprecate the cautodoc_transformations config, the
hawkmoth.ext.transformations extension, and the hawkmoth.util.doccompat
module.

Everyone should move to either the hawkmoth.ext.javadoc or
hawkmoth.ext.napoleon extensions, or if they're not enough, implement
their own extensions through the hawkmoth-process-docstring event. The
javadoc/doxygen helpers in doccompat are inferior to the
hawkmoth.ext.javadoc extension, and the kernel-doc "support" is two
regexes in a row.

Functionally, the deprecation means 1) not loading
hawkmoth.ext.transformations automatically, i.e. you have to manually
add it to extensions in conf.py, and 2) deprecation messages on loading
the extension and the module.
    @jnikula
    jnikula committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    0550ce3 View commit details
    Browse the repository at this point in the history

  2. cli: remove --compat for hawkmoth.util.doccompat based docstring proc… 

    …essing

The hawkmoth.util.doccompat module has been deprecated. Remove the
--compat option and the dependency on the module.

The alternative is to use the --process-docstring option. It does lack
the kernel-doc support, but it was simplistic to begin with.
    @jnikula
    jnikula committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    4836166 View commit details
    Browse the repository at this point in the history

  3. extension: remove cautodoc_root and cautodoc_clang config options 

    The cautodoc_root and cautodoc_clang config options have been deprecated
in favour of hawkmoth_root and hawkmoth_clang since Hawkmoth
v0.13.0. Remove them.
    @jnikula
    jnikula committed Sep 11, 2024
    Configuration menu
    Copy the full SHA
    61436c1 View commit details
    Browse the repository at this point in the history