Right now the DM usage of automodapi is to skip module docstrings because we don't want to bloat API reference listings with a lot of text that might reside in module docstrings. The downside of this is that we don't get proper markers for those modules, so we can't link to modules using the Python domain in Sphinx. A neat compromise might be to dynamically strip our module docstrings down to their one-sentence summaries (if a docstring does exist), and then permit module docstrings with automodapi. I think this can be done with an autodoc hook.
Right now the DM usage of
automodapi
is to skip module docstrings because we don't want to bloat API reference listings with a lot of text that might reside in module docstrings. The downside of this is that we don't get proper markers for those modules, so we can't link to modules using the Python domain in Sphinx. A neat compromise might be to dynamically strip our module docstrings down to their one-sentence summaries (if a docstring does exist), and then permit module docstrings withautomodapi
. I think this can be done with anautodoc
hook.