Skip to content

mkdocs.yml's mkdocstrings uses an obsolete method (rendering) #48

Description

@jibanes

rendering:

[...]
  - mkdocstrings:
      handlers:
        python:
          rendering:              <---- no longer supported
            docstring_section_style: 'table'
            heading_level: 2
            line_length: 80
            members_order: 'source'
            merge_init_into_class: true
[...]

Per https://mkdocstrings.github.io/usage/handlers/?h=rendering#rendering-options :
"Since mkdocstrings 0.19, the YAML rendering key is merged into the options key."
Note: 0.19 was released in May 28, 2022.

Naturally, replacing "rendering:" with "options:" fixes it and allows mkdocs to run using a recent (>2022) version of mkdocstrings.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions