DM-25337: Add -W (warnings as errors) and -n nitpicky mode for stack-docs / package-docs build
#167
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
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.
The 0.8 release is running off a release branch while we're building 1.0.0; this commit catches the change log up.
The issue is that the project root discovery as being done in the main command entrypoint before being passed to sub-commands like build and clean. This meant that even "help" was running code to discover the root of the project directory. Now the raw root directory input is being passed to the commands that need it, and those commands are running the package discovery. Now package-docs build -h or package-docs help build will work.
This enables Sphinx's nitpicky mode that raises warnings for unresolvable links and similar issues.
jonathansick
force-pushed
the
tickets/DM-25337
branch
from
1c27b30
to
ad4a7eb
Compare
jonathansick
force-pushed
the
tickets/DM-25337
branch
from
ad4a7eb
to
61ec93d
Compare
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.
This ports #164, which created the 0.8.0 release, to the main branch for future releases (e.g. 1.0.0). Also fixes the issue with the
helpsubcommand not working on sub-commands ofstack-docsandpackage-docs.