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

Cluttered autodoc output #446

Closed
duckontheweb opened this issue Jun 15, 2021 · 0 comments · Fixed by #1137
Closed

Cluttered autodoc output #446

duckontheweb opened this issue Jun 15, 2021 · 0 comments · Fixed by #1137
Assignees
Labels
documentation Issues related to PySTAC documentation
Milestone

Comments

@duckontheweb
Copy link
Contributor

The autodoc output can be a bit cluttered and hard to make sense of in some cases. This is especially evident in function/method signatures that use other PySTAC classes as types, and when showing class inheritance, because the fully qualified path is used. The EOExtension class documentation is a good example of this: the Bases are more verbose than they need to be, and the type annotations in apply and ext are a little hard to make sense of at first.

We might be able to take advantage of the autodoc-process-signature event to clean up function signatures. When Sphinx 4.1 is released, we may also be able to take advantage of autodoc-process-bases to clean up the Bases section.

@duckontheweb duckontheweb added the documentation Issues related to PySTAC documentation label Jun 15, 2021
@duckontheweb duckontheweb self-assigned this Feb 16, 2022
@gadomski gadomski added this to the 1.8 milestone Jan 31, 2023
@jsignell jsignell self-assigned this May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues related to PySTAC documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants