Plans to declassify filters parameter as sponsors only?

[staadecker]

Hi @pawamoy,

Thank you for the wonderful library! It's really helping Python users transition from the Sphinx ecosystem to the (imo better) mkdocs ecosystem.

I was wondering if there are any plans to make filters available to everyone (not only sponsors)? Of course, I understand the need for some of the nice-to-have features to be for sponsors only; open-source projects need to find a way to fund themselves! However, I personally think that having no way to hide one's numerous dunder methods from their documentation is a significant limitation / issue with mkdocstrings, not simply a missing nice-to-have feature. To give you an idea, my documentation is currently overwhelmed with dunder methods as shown below.

If filters is to continue to be sponsors only, do you recommend using the legacy python handler? What are the main drawbacks of the legacy handler? I couldn't find a comparison between the two online.

Thanks!
Martin

[pawamoy]

Hi @staadecker 🙂 That feature is already (and always was) available to everyone. Have you tried using it and got unexpected results?

[staadecker]

Yes. Here is my mkdocs.yml

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            inherited_members: true
            # filters:
            #   - ["!^_"]
            show_if_no_docstring: true
            summary:
              attributes: true
              functions: true
              classes: true
              modules: false
            extensions:
              - dataclasses
            merge_init_into_class: true
            docstring_options:
              ignore_init_summary: true
              trim_doctest_flags: true

It works fine until I uncomment the two commented lines, at which point I get:

ERROR   -  Error reading page 'reference/public.md':
ERROR   -  Invalid options: 'list' object has no attribute 'removeprefix'

Aborted with a BuildError!

I'm using mkdocstrings-python version 1.16.12 and Python 3.13.5.

Thank you for clarifying that it wasn't a sponsors only feature! I was confused by the sponsors only label under the "Filtering methods" section in the documentation.

[staadecker]

Aha, found the issue! I shouldn't enclose the filters in a list since the yaml already makes the list. Thank you!

(I had copied the filters from the "Common Filters" section and didn't think to remove the square brackets.)

[pawamoy]

Glad you found the solution!