DM-37783: Add -W flag to package-docs build / stack-docs build #164
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonathansick
force-pushed
the
tickets/DM-37783
branch
2 times, most recently
from
34078da
to
bd85d6e
Compare
This option trigger's Sphinx's own -W option, which causes warnings to be treated as errors. This may be useful for CI implementations for package-docs build where a documentation set should be able to build without warnings, and any warnings should cause a CI run to fail.
jonathansick
force-pushed
the
tickets/DM-37783
branch
from
bd85d6e
to
4defeb1
Compare
This enables Sphinx's nitpicky mode that raises warnings for unresolvable links and similar issues.
jonathansick
force-pushed
the
tickets/DM-37783
branch
from
7e42d8e
to
17366e4
Compare
Closed
2 tasks
This version introduced a Sphinx constraint >= 7, which conflicts with a constraint in sphinx-design 0.4.1. We'll use this pin for now and hopefully we can drop it when sphinx_design updates.
This was referenced Jun 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a
-W/--warning-is-errorflag to thepackage-docs buildandstack-docs buildcommands for Science Pipelines documentation builds. This flag causes Sphinx to treat warnings as errors, which is useful for CI builds.Will be released as 0.8.0