Skip to content

DOC: remove hack to override _add_newdocs_scalars - #26826

Merged
melissawm merged 1 commit into
numpy:mainfrom
mattip:remove-hack
Jul 2, 2024
Merged

melissawm merged 1 commit into
numpy:mainfrom
mattip:remove-hack

Conversation

@mattip

@mattip mattip commented Jul 2, 2024

Copy link
Copy Markdown
Member

Fixes #26820, replaces #26825

Something has changed in the way autoclasses adds all the members. The function replace_scalar_type_names is still needed, but locally removing _add_newdocs_scalars is not. If I totally remove replace_scalar_type_names, documentation is built with full class methods for float16, but not so if the function is in place.

@mattip

mattip commented Jul 2, 2024

Copy link
Copy Markdown
Member Author

As far as I can tell the scalars documentation from this PR and from the devdocs are the same. @melissawm am I missing something?

@mattip

mattip commented Jul 2, 2024

Copy link
Copy Markdown
Member Author

Comparing the HTML, there is an additional Canonical name: field in the documentation from this PR, otherwise the HTML is identical.

@melissawm melissawm left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This looks good to me and does build perfectly locally. Thanks @mattip and @mtsokol for the investigation!

@melissawm
melissawm merged commit b853278 into numpy:main Jul 2, 2024
@charris charris added the 09 - Backport-Candidate PRs tagged should be backported label Jul 2, 2024
charris pushed a commit to charris/numpy that referenced this pull request Jul 2, 2024
@charris charris removed the 09 - Backport-Candidate PRs tagged should be backported label Jul 2, 2024
charris added a commit that referenced this pull request Jul 2, 2024
DOC: remove hack to override _add_newdocs_scalars (#26826)
ArvidJB pushed a commit to ArvidJB/numpy that referenced this pull request Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

DOC, CI: Docs build is failing on CircleCI

3 participants