Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[MRG] Sphinx: warnings are errors #1610

Merged
merged 5 commits into from Mar 28, 2020
Merged

[MRG] Sphinx: warnings are errors #1610

merged 5 commits into from Mar 28, 2020

Conversation

manics
Copy link
Member

@manics manics commented Mar 28, 2020 •
edited

As suggested in #1601 (comment) changes Sphinx warnings to errors

  1. First commit adds -W to convert warnings to errors, circle-ci fails.
  2. Second commit fixes the errors detected in (1), circle-ci passes. Note the broken cross references from Broken docs cross-links #1601 were not detected
  3. Third commit fixes the broken internal links

Closes #1601

Updated:

  • Bump sphinx so --keep-going flag can be used to show all doc errors

manics
manics commented Mar 28, 2020
View reviewed changes
.circleci/config.yml Outdated Show resolved Hide resolved
@manics
Fix sphinx warnings/errors
f03eb3c
@manics
Fix some broiken internal cross-references
cbba0bc 
Note these _weren't_ detected as warnings or errors 😞
@manics manics changed the title [WIP] Sphinx: warnings are errors [MRG] Sphinx: warnings are errors Mar 28, 2020
@manics manics marked this pull request as ready for review March 28, 2020 17:16
@manics manics mentioned this pull request Mar 28, 2020
Closed
@choldgraf choldgraf merged commit 2af4614 into jupyterhub:master Mar 28, 2020
@choldgraf
Copy link
Member

This looks great to me - thanks for the fixes, this will make it easier to avoid the docs going out-of-date (at least in terms of links etc)

@manics manics deleted the sphinx-warn-errors branch March 29, 2020 07:37
@manics manics mentioned this pull request Apr 16, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@choldgraf choldgraf choldgraf left review comments

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

Successfully merging this pull request may close these issues.

Broken docs cross-links
2 participants
@manics @choldgraf