Strip docstring from source code examples

[derek-adair]

It would be very nice to be able to just look at the source code w/o all the comments.

Live Example

If you expand play you can see that the documentation text is quite long and does not need to be there.

It'd also be cool to remove any other config/text that is predictable.

[kernc]

I understood you'd like to collapse the repeated docstring in the item's source code view.

Pdoc only outputs raw <pre><code>, leaving further markup to Highlight.js:

pdoc/pdoc/templates/html.mako

Lines 427 to 430 in 0042043

	% if syntax_highlighting:
	<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
	<script>hljs.initHighlightingOnLoad()</script>
	% endif

You can remove the strings if you issue:

Array.from(document.querySelectorAll(
    '.source code.python .hljs-class + .hljs-string, \
     .source code.python .hljs-function + .hljs-string'
)).forEach(el => el.parentNode.removeChild(el))

I guess something similar could be issued to wrap in <details>. I'd be interested in a small working snippet if you find it. 👍

[derek-adair]

I was thinking something in the python code. There is no reason to have the docstring in the code source link.

[derek-adair]

oh i misunderstood. I'll have to dig in and submit a PR i guess.