Partially, the problem is it is hard to reuse modules or class documentation in high-level introductory docs written in mkdocs, at least when using Google style, because it mandates a summary line, which doesn't play well with the prose one usually expects from higher level docs.
Add an option like show_docstring_summary
that when set to false
it will remove the summary line from the docstring description. The default should be true
.
By setting show_docstring_description
to false
and show_docstring_summary
to true
it would also be possible to only show the summary.
I tried using mkdocs-macros
to remove the summary, but then the sections in the docstring are not added to the ToC, so it is not a full solution.
Discussion in Gitter: https://matrix.to/#/!xiyyvEeLIRaWsNQixq:gitter.im/$htcAJ1uZX3Af1I8Icn1xwFfqUm0ghhVBO1mwziuaSAo?via=gitter.im&via=matrix.org
Pay now to fund the work behind this issue.
Get updates on progress being made.
Maintainer is rewarded once the issue is completed.
You're funding impactful open source efforts
You want to contribute to this effort
You want to get funding like this too