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

Autodoc typehints #350

Merged
merged 3 commits into from
Jan 22, 2025
Merged

Autodoc typehints #350

merged 3 commits into from
Jan 22, 2025

Conversation

oerc0122
Copy link
Collaborator

@oerc0122 oerc0122 commented Nov 8, 2024 •
edited
Loading

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

@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.

@oerc0122 oerc0122 force-pushed the autodoc-typehints branch 3 times, most recently from aa317db to c80b604 Compare January 17, 2025 17:01
@oerc0122 oerc0122 changed the title [WIP] Autodoc typehints Autodoc typehints Jan 17, 2025
ElliottKasoar
ElliottKasoar reviewed Jan 22, 2025
View reviewed changes
Copy link
Member

@ElliottKasoar ElliottKasoar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left one minor comment, but looks great, thanks! I think you'll need to rebase to fix the MacOS tests

docs/source/conf.py Outdated Show resolved Hide resolved
@ElliottKasoar ElliottKasoar merged commit 93b9f9c into main Jan 22, 2025
20 checks passed
@ElliottKasoar ElliottKasoar deleted the autodoc-typehints branch January 22, 2025 16:57
@ElliottKasoar ElliottKasoar mentioned this pull request Jan 30, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ElliottKasoar ElliottKasoar ElliottKasoar approved these changes

@alinelena alinelena Awaiting requested review from alinelena

Assignees

@oerc0122 oerc0122

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@oerc0122 @ElliottKasoar