Fix docs for module-level API#1091
Merged
rapids-bot[bot] merged 13 commits intorapidsai:branch-22.10from Aug 23, 2022
Merged
Conversation
This reverts commit 1f70d63.
bdice
commented
Aug 23, 2022
| "IPython.sphinxext.ipython_directive", | ||
| "nbsphinx", | ||
| "recommonmark", | ||
| "sphinx.ext.napoleon", |
Collaborator
Author
There was a problem hiding this comment.
FYI: this extension was causing havoc with the docs. A lot of things weren't rendering properly, and I would guess it was because of napoleon interacting poorly with Cython-generated docs or a conflict with some other Sphinx extension. The numpydoc extension is sufficient to use on its own nowadays, and napoleon isn't needed here.
bdice
commented
Aug 23, 2022
bdice
commented
Aug 23, 2022
shwina
approved these changes
Aug 23, 2022
msadang
approved these changes
Aug 23, 2022
Contributor
msadang
left a comment
There was a problem hiding this comment.
Comment and sphinx edits look good.
Collaborator
Author
|
@gpucibot merge |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR's primary intention is to fix the
rmmmodule API documentation so that classes likeDeviceBufferappear, and to remove documentation for thermm.rmmsubmodule in favor of the top-level API that defines all public names. I fixed all warnings that appear when building with Sphinx, and addressed a few other minor issues that didn't deserve their own PRs but were important to fix. I rendered the docs locally and the difference is very substantial -- parameter docstrings, public properties of classes, and other names now automatically appear or render correctly where they weren't before.Checklist