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

[WIP] Autodoc typehints #350

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[WIP] Autodoc typehints #350

wants to merge 2 commits into from

Conversation

oerc0122
Copy link
Collaborator

@oerc0122 oerc0122 commented Nov 8, 2024

Use sphinx_autodoc_typehints to extract linked typehints from signatures rather then repeating in documentation.

Currently reports nitpick issues, which need resolving.

@oerc0122 oerc0122 added the documentation Improvements or additions to documentation label Nov 8, 2024
@oerc0122 oerc0122 self-assigned this Nov 8, 2024
@ElliottKasoar
Copy link
Member

Looks good in principle.

I think you'll need to change the numpydoc-validation too.

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

Successfully merging this pull request may close these issues.

2 participants