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

Improve Sphinx documentation extraction #96

Open
ChrisEPhifer opened this issue Oct 8, 2020 · 0 comments
Open

Improve Sphinx documentation extraction #96

ChrisEPhifer opened this issue Oct 8, 2020 · 0 comments
Labels
Docs Documentation

Comments

@ChrisEPhifer
Copy link
Member

As of right now, we're naively extracting documentation from Python docstrings. This could be improved significantly by putting in some more manual work: Careful consideration of what double-underscore methods to include, what order to present the documentation, etc.

Personally, I like the guiding principle of "tell a story" - Even documentation of a module's interface should have a natural flow that makes its intended use clear.

@ChrisEPhifer ChrisEPhifer added the Docs Documentation label Oct 8, 2020
@ChrisEPhifer ChrisEPhifer self-assigned this Oct 8, 2020
@ChrisEPhifer ChrisEPhifer removed their assignment Dec 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs Documentation
Projects
None yet
Development

No branches or pull requests

1 participant