Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sphinx extension that strips module docstrings down to 1-sentence summary. #84

Open
jonathansick opened this issue Jan 24, 2020 · 0 comments

Comments

@jonathansick
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant