Skip to content

bug: show_symbol_type_toc not working with newest version of Python handler / material theme #158

@femtomc

Description

@femtomc

Hi!

Description of the bug

I'm using the newest insider's edition of mkdocstrings-python, and I'm attempting to use:

plugins:
  - mkdocstrings:
      enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
      handlers:
        python:
          options:
            show_symbol_type_toc: true

in my documentation (with an admittedly old insider's edition of mkdocs-material). However, the symbols are not rendering in the side ToC.

Expected behavior

I expect the symbol types to show up next to the entries in the side ToC.

Environment information

Here's my exact versioning:

mkdocs                                    1.5.3
mkdocs-autorefs                           1.0.1
mkdocs-git-authors-plugin                 0.7.2
mkdocs-git-committers-plugin-2            1.2.0
mkdocs-git-revision-date-localized-plugin 1.2.5
mkdocs-material                           9.5.4+insiders.4.49.2
mkdocs-material-extensions                1.3.1
mkdocstrings                              0.25.0
mkdocstrings-python                       1.10.0.1.8.2.dev19+g995e505

Additional context

Now, I do have some errors in my documentation -- but all other mkdocstrings-python options work correctly (e.g. show_symbol_type_heading works fine) and I can switch them on and off and build my documentation without issue.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
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