Description
Hi,
First thing : mkdocstrings is awesome.
That being said, I'd like to hide the function's description when using the ::: app.function syntax.
For example, if I have this function in an app.py file:
def mkdocstrings_is_awesome(fish: str, percolator: set) -> bool:
"""But I'd be better if I could hide this description!
Args:
fish (str): a fish.
percolator (set): this thing in a coffee machine.
Returns:
bool: whether there is a fish in the percolator.
"""
return fish in percolatorand the mkdocstrings plugin called in my mkdocs.yml, the ::: app.mkdocstrings_is_awesome line renders this first screenshot.
I'd like an option like ignore_description to be able to render the second screenshot.
::: app.mkdocstrings_is_awesome
options:
ignore_description: true
And that's about it. Thanks again for this plugin! 😄