Display only the docstring of a class (Class.__doc__)
#302
Replies: 3 comments 5 replies
-
|
Found a hack for my usecase: ::: flet.Switch
options:
show_root_heading: false
show_bases: false
members: false
inherited_members: false
show_root_toc_entry: false
show_docstring_attributes: false
show_docstring_functions: false
show_docstring_examples: false
show_docstring_parameters: false
show_docstring_other_parameters: false
show_docstring_raises: false
show_docstring_receives: false
show_docstring_returns: false
show_docstring_warns: false
show_docstring_yields: falseWill still like to know if it could be eased in some way. |
Beta Was this translation helpful? Give feedback.
-
|
Also, will please like to know how to display all but the class's docstring. Tried several things but couldnt get it out. 
Basically in some section in want just the docstring and in another section i need all but it. |
Beta Was this translation helpful? Give feedback.
-
|
Try https://mkdocstrings.github.io/python/usage/configuration/docstrings/#show_docstring_description |
Beta Was this translation helpful? Give feedback.
-
|
I tried this already, but only issue I have with it is that it removes admnitions too 🥹 
This option is awesome, but in my usecase I will like the admonitions to be kept, similar to |
Beta Was this translation helpful? Give feedback.
-
|
Let me just brief my usecase and need, while hoping it is possible to have it :) I have this structure for my docpage on the Here is my class: Before the Examples, I want to display a the docstring of the class, precisely, only the summary and description. (no admonition/Raises etc) With the 'hack' I came up with above and 
Only last thing I want to achieve is the admonition not to be shown in the intro (first image) but in the class doc (second image). 🥹 Thanks! |
Beta Was this translation helpful? Give feedback.
-
|
I see, thanks for explaining your use-case 🙂 Unfortunately, if we implement a |
Beta Was this translation helpful? Give feedback.
-
|
IMO admonitions should be treated as part of the docstring body/description, since they can appear anywhere in the docstring, whether they're written as Google-style admonitions or Markdown admonitions (using whatever syntax/markup and according extension). |
Beta Was this translation helpful? Give feedback.
-
Yeah, that would make sense. What options do you please see for me, if I want to implement this for personal usage though?
Fork this project and try to modify the internal logic? Or create an extension/plugin? |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
For my usecase, I want to display just the content of Class's docstring (
Class.__doc__) in my page.I tried
::: package.Class.__doc__but it failed:ERROR - mkdocstrings: flet.Switch.__doc__ could not be found ERROR - Error reading page 'controls/switch.md': ERROR - Could not collect 'flet.Switch.__doc__'Let me please know if it is possible, and if yes, how?
Thanks!
Beta Was this translation helpful? Give feedback.
All reactions