-
Notifications
You must be signed in to change notification settings - Fork 206
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.
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
Fix docs for module-level API #1091
Conversation
This reverts commit 1f70d63.
@@ -39,7 +45,6 @@ | |||
"IPython.sphinxext.ipython_directive", | |||
"nbsphinx", | |||
"recommonmark", | |||
"sphinx.ext.napoleon", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comment and sphinx edits look good.
@gpucibot merge |
Description
This PR's primary intention is to fix the
rmm
module API documentation so that classes likeDeviceBuffer
appear, and to remove documentation for thermm.rmm
submodule 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