Skip to content

fix sphinx warnings #4199

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Merged
merged 4 commits into from
Jul 7, 2020
Merged

fix sphinx warnings #4199

merged 4 commits into from
Jul 7, 2020

Conversation

keewis
Copy link
Collaborator

@keewis keewis commented Jul 4, 2020

This adds back the fail-on-warnings flag we lost during the move the RTDs PR preview, and also fixes the warnings that have accumulated since then.

  • Tests added
  • Passes isort -rc . && black . && mypy . && flake8
  • User visible changes (including notable bug fixes) are documented in whats-new.rst
  • New functions/methods are listed in api.rst

@keewis
Copy link
Collaborator Author

keewis commented Jul 4, 2020 •
edited
Loading

it seems we can't enable fail_on_warning since now RTD tries to build in parallel (-j auto), and readthedocs-sphinx-ext doesn't declare itself as parallel_read_safe. So we have to wait until the next release of readthedocs-sphinx-ext until we can actually enable fail_on_warning (or could we try installing from github? Might be risky).

@keewis keewis changed the title Re-enable failing on warnings fix sphinx warnings Jul 4, 2020
@dcherian
Copy link
Contributor

dcherian commented Jul 7, 2020

Thanks @keewis

@dcherian dcherian merged commit f3ca63a into pydata:master Jul 7, 2020
@keewis keewis deleted the fix-warnings branch July 7, 2020 15:19
@max-sixty
Copy link
Collaborator

Thanks @keewis !

@keewis keewis mentioned this pull request Jul 25, 2020
Merged
1 task
dcherian added a commit to dcherian/xarray that referenced this pull request Aug 16, 2020
@dcherian
Merge branch 'master' into fix/4107
2b39154 
* master:
  Add initial cupy tests (pydata#4214)
  Add 0.16.0 release summary
  New whatsnew section
  Release v0.16.0
  Minor reorg of whatsnew for 0.16.0 (pydata#4216)
  fix sphinx warnings (pydata#4199)
  pin isort (pydata#4206)
  get the colorbar label via public methods (pydata#4201)
  Bump minimum versions for 0.16 release (pydata#4175)
  Allow passing axis kwargs to plot (pydata#4020)
  Fix to_unstacked_dataset for single dimension variables. (pydata#4094)
  Improve the speed of from_dataframe with a MultiIndex (by 40x!) (pydata#4184)
  More pint compatibility: silence UnitStrippedWarnings (pydata#4163)
  Fix typo (pydata#4192)
  use the latest image of RTD (pydata#4191)
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@shoyer shoyer shoyer approved these changes

@dcherian dcherian dcherian approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@keewis @dcherian @max-sixty @shoyer