Skip to content

Update sphinx currentmodule usage#6839

Merged
mrocklin merged 1 commit intodask:masterfrom
jrbourbeau:current-module-fixup
Nov 14, 2020
Merged

Update sphinx currentmodule usage#6839
mrocklin merged 1 commit intodask:masterfrom
jrbourbeau:current-module-fixup

Conversation

@jrbourbeau
Copy link
Copy Markdown
Member

Currently we have several instances of #doctest: +SKIP being used in conjunction with .. currentmodule:: in our docs. This is causing API docs to not render properly (see screenshots below). This PR removes #doctest: +SKIP which results in API docs rendering as expected

Current rendering:

Screen Shot 2020-11-13 at 1 59 37 PM

With the changes in this PR:

Screen Shot 2020-11-13 at 1 59 40 PM

  • Tests added / passed
  • Passes black dask / flake8 dask

@mrocklin mrocklin merged commit 64bbc68 into dask:master Nov 14, 2020
@jrbourbeau jrbourbeau deleted the current-module-fixup branch November 14, 2020 20:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants