Skip to content

Support newline between autodoc identifer and YAML options #450

@Archmonger

Description

@Archmonger

The current syntax of ...

::: my_package.my_module.MyClass
    handler: python
    options:
      members:
        - method_a
        - method_b
      show_root_heading: false
      show_source: false

... does not play well with markdown formatters.

Consider changing the syntax. Here's some ideas.

A markdown list, in conjunction with a flag variable

::: my_package.my_module.MyClass has_options=true

    - handler: python
    - options
      - members
        - method_a
        - method_b
      - show_root_heading: false
      - show_source: false

A markdown list, with an indicator flag

::: my_package.my_module.MyClass

    - #!mkdocstrings
    - handler: python
    - options
      - members
        - method_a
        - method_b
      - show_root_heading: false
      - show_source: false

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions