DOC: Add ufunc docstring to generated docs.#16919
Conversation
Adds the ufunc class to the documentation so that it is included in the generated html docs and all links to it work. Slightly modify ufunc docstring to remove unrecognized heading name.
|
Close/Reopen for CI |
|
The page has all the extra info about the class on it and not on the class sub-page. I think the entire section should be moved to a new page and reformatted. |
|
It would be good if we could pull the Once we've done that, we can put the docstrings back in the rst with |
|
We could just put this in as-is since the new page is no worse than the old one. On the other hand, now we have a subpage, which did not exist before. @rossbar - thoughts? |
|
I don't have any particular preferences/ideas on the organization. The main reason I chose to add it in this was was that it was very simple and would fix some broken links in the rendered docs. We could add a new subpage (e.g. |
|
Yes, a new subpage was my intention. The question is if we should do it in this PR or in a follow-on one. |
|
.. and if you at all agree that it is an improvement |
I think it would be, though I also think it might take a decent chunk of effort to get the reorganization right, especially since there are links that point to the ufunc page in the refguide that would probably then be better pointed at the new subpage |
|
OK, let's put this in as-is then. |
|
Thanks @rossbar |
|
I am going to open an issue to keep track of the subpage suggestion. I also found this file which appears not to be connected to the generated documentation. |
Closes #16791
Adds the ufunc class to the documentation so that it is included
in the generated html docs and all links to it work.
A slight modification to the ufunc docstring was necessary to suppress a warning during the doc build process.