Skip to content

Fix docs for module-level API#1091

Merged
rapids-bot[bot] merged 13 commits intorapidsai:branch-22.10from
bdice:doc/module-api
Aug 23, 2022
Merged

Fix docs for module-level API#1091
rapids-bot[bot] merged 13 commits intorapidsai:branch-22.10from
bdice:doc/module-api

Conversation

@bdice
Copy link
Collaborator

@bdice bdice commented Aug 23, 2022

Description

This PR's primary intention is to fix the rmm module API documentation so that classes like DeviceBuffer appear, and to remove documentation for the rmm.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

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@bdice bdice requested review from a team as code owners August 23, 2022 00:40
@bdice bdice self-assigned this Aug 23, 2022
@bdice bdice added doc Documentation non-breaking Non-breaking change labels Aug 23, 2022
@github-actions github-actions bot added conda Python Related to RMM Python API labels Aug 23, 2022
"IPython.sphinxext.ipython_directive",
"nbsphinx",
"recommonmark",
"sphinx.ext.napoleon",
Copy link
Collaborator Author

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.

Copy link
Contributor

@msadang msadang left a 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.

@bdice
Copy link
Collaborator Author

bdice commented Aug 23, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 6eb255d into rapidsai:branch-22.10 Aug 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conda doc Documentation non-breaking Non-breaking change Python Related to RMM Python API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants