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.

Sign up for GitHub

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

Jump to bottom

Class properties' autosummary table doesn't include docstring preview #344

Closed
mhostetter opened this issue Apr 19, 2022 · 1 comment · Fixed by #370
Closed

Class properties' autosummary table doesn't include docstring preview #344

mhostetter opened this issue Apr 19, 2022 · 1 comment · Fixed by #370
Labels
documentation Improvements or additions to documentation

Comments

@mhostetter
Copy link
Owner

After #343, the class methods and properties from FieldClass are now displayed in FieldArray. However, the class properties' autosummary table doesn't show the docstring preview. It would be nice to monkey-patch autosummary to do that correctly.

image

The detailed description is correct, however.

image
@mhostetter mhostetter added the documentation Improvements or additions to documentation label Apr 19, 2022
@mhostetter
Copy link
Owner Author

This will be resolved once porting over to the new Sphinx Immaterial python-apigen.

@mhostetter mhostetter linked a pull request Jul 14, 2022 that will close this issue
Use Sphinx Immaterial's python-apigen for API Reference #370
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use Sphinx Immaterial's python-apigen for API Reference mhostetter/galois
1 participant
@mhostetter