Skip to content

DOC: Create templates for ma documents #17515

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
Closed
wants to merge 2 commits into from
Closed

DOC: Create templates for ma documents #17515

wants to merge 2 commits into from

Conversation

takanori-pskq
Copy link

Related to #13114. See #16736 (comment). .. currentmodule didn't work, so I used .. auto*:: numpy::ma.* instead. After this change, methods in numpy(e.g. lexsort) can be found, but methods in numpy.ma(e.g. MaskedArray.*) cannot be found.

@takanori-pskq takanori-pskq mentioned this pull request Oct 9, 2020
Merged
@takanori-pskq
Copy link
Author

takanori-pskq commented Oct 9, 2020 •
edited
Loading

Or is it a good idea to apply this kind of change to not only ma but also all docstrings ? It is much simpler (only modifing {{ objname }} to {{ fullname|replace("numpy.", "numpy::") }} in autosummary/*.rst, and no need to add templates ma/*.rst and :template: options)

@rossbar rossbar self-requested a review October 9, 2020 19:23
@mattip
Copy link
Member

mattip commented Oct 29, 2020

Could you link to this in the rendered docs?

@takanori-pskq
Copy link
Author

For example: https://16245-908607-gh.circle-artifacts.com/0/doc/build/html/reference/generated/numpy.ma.MaskedArray.argsort.html
Here now `lexsort` can reference to numpy.lexsort, but `MaskedArray` cannot reference to numpy.ma.MaskedArray. (before: https://numpy.org/devdocs/reference/generated/numpy.ma.MaskedArray.argsort.html)

@mattip
Copy link
Member

mattip commented Oct 29, 2020

Ahh, I see, thanks.

It is much simpler (only modifying...

Worth a try, if it is not too complicated. It would be nice to add a comment near the change to explain what is going on.

@takanori-pskq takanori-pskq mentioned this pull request Nov 2, 2020
Merged
@takanori-pskq
Copy link
Author

Another way mentioned above is in the PR #17691 .

@mattip
Copy link
Member

mattip commented Nov 4, 2020

Closing in favor of gh-17691

@mattip mattip closed this Nov 4, 2020
@takanori-pskq takanori-pskq deleted the i13114-ma-docstring branch November 4, 2020 13:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rossbar rossbar Awaiting requested review from rossbar

Assignees
No one assigned
Labels
04 - Documentation component: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@takanori-pskq @mattip @charris