Handling misconfiguration

[ofek]

To Reproduce

# Utilities

-----

::: extension.utils
    show_root_heading: false
    show_root_toc_entry: false
    heading_level: 1
    members:
    - get_env_option
    filters:
    - "!__all__"

Screenshots

System (please complete the following information):

• mkdocstrings-python version: [e.g. 0.7.0]
• Python version: 3.8
• OS: Windows

[pawamoy]

Ah, I didn't see it at first: you're missing the options key 😅

::: extension.utils
    options:
      show_root_heading: false
      show_root_toc_entry: false
      heading_level: 1
      members:
      - get_env_option
      filters:
      - "!__all__"

There was some discussion in this PR about removing the options key since it's redundant most of the time. I've left that as "might change later".

[pawamoy]

I'll leave it open because we could detect such misconfigurations and emit warnings.

[ofek]

bruh 🤦‍♂️ sorry

[ofek]

removing the options key

I'd recommend not doing that to be more future-proof