You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
From my reading of the documentation, I don't see any way to supress the docstring, and only show the summary line(s) of the docstring.
We are hoping to have 2 different blocks.... One will only show the summary (being a "non-technical") summary, and then another in a collapsed annotation that has the whole 9 yards.
This allows the documentation to be used for non-technical (non-programmers), using the summary only listing, And allow programmers to view the same documentation.
As mentioned, using mkdocs w/mkdocstring[python] plugin, seems to work fine except I can't get the summary option to work.
Expected behavior
The ability to show the docstring summary, without the rest of the docstring.
Environment information
python -m mkdocstrings_handlers.python.debug # | xclip -selection clipboard> No module named mkdocstrings_handlers.python.debug
The following libraries are loaded:
mkdocs 1.5.3 Project documentation with Markdown.
mkdocs-autorefs 1.0.1 Automatically link across pages in MkDocs.
mkdocs-material 9.5.10 Documentation that simply works
mkdocs-material-extensions 1.3.1 Extension pack for Python Markdown and MkDocs Material.
mkdocstrings 0.24.1 Automatic documentation from sources, for MkDocs.
mkdocstrings-python 1.7.3 A Python handler for mkdocstrings.
The text was updated successfully, but these errors were encountered:
If this option does nothing for you, it's probably because you are not using the Insiders version of mkdocstrings-python: this feature is available to sponsors only (as explained in the docs). It will become available to everyone once the $1000/month goal is reached, see https://mkdocstrings.github.io/python/insiders/#1000-gravifridge-user-manual 🙂
Would this option work for you, or would you prefer to get an additional option like show_docstring_summary, that you could set to true and combine with show_docstring_description: false in order to only show the summary of a given object?
Description of the bug
From my reading of the documentation, I don't see any way to supress the docstring, and only show the summary line(s) of the docstring.
We are hoping to have 2 different blocks.... One will only show the summary (being a "non-technical") summary, and then another in a collapsed annotation that has the whole 9 yards.
This allows the documentation to be used for non-technical (non-programmers), using the summary only listing, And allow programmers to view the same documentation.
I see a "summary" option,
python/src/mkdocstrings_handlers/python/handler.py
Line 157 in eaf9b82
But it seems to do nothing...
e.g. summary: true, appears to do nothing.
To Reproduce
As mentioned, using mkdocs w/mkdocstring[python] plugin, seems to work fine except I can't get the summary option to work.
Expected behavior
The ability to show the docstring summary, without the rest of the docstring.
Environment information
The following libraries are loaded:
mkdocs 1.5.3 Project documentation with Markdown.
mkdocs-autorefs 1.0.1 Automatically link across pages in MkDocs.
mkdocs-material 9.5.10 Documentation that simply works
mkdocs-material-extensions 1.3.1 Extension pack for Python Markdown and MkDocs Material.
mkdocstrings 0.24.1 Automatic documentation from sources, for MkDocs.
mkdocstrings-python 1.7.3 A Python handler for mkdocstrings.
The text was updated successfully, but these errors were encountered: