Skip to content

show_source option from mkdocstrings breaks when mkdocs-click is enabled #93

@ghost

Description

Hi, first of all thanks for your work on this project!

I’m opening this issue because I’ve encountered a conflict between mkdocs-click and the show_source option from the mkdocstrings plugin.

When I enable mkdocs-click under markdown_extensions, the show_source: true option from mkdocstrings seems to stop working — the source code no longer appear.

Here’s a simplified version of my configuration:

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - attr_list
  # - mkdocs-click  <-- enabling this causes the issue

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [<app>]
          options:
            show_source: true

I’d like to be able to decide whether to show the source or not, but currently enabling mkdocs-click removes that choice — the source is simply not shown.

To help illustrate the problem, I’ve attached two screenshots:

  • One with mkdocs-click enabled (no source code visible)
  • One without it (source code link is visible as expected)

Let me know if I can provide more details or help debug this further.

Thanks again!

mkdocs-click enabled and show_source: true
Image

mkdocs-click disabled and show_source: true
Image

Metadata

Metadata

Assignees

No one assigned

    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