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

Add config v2.0 sphinx/mkdocs fail_on_warning options #4219

Closed
agjohnson opened this issue Jun 11, 2018 · 2 comments
Closed

Add config v2.0 sphinx/mkdocs fail_on_warning options #4219

agjohnson opened this issue Jun 11, 2018 · 2 comments
Assignees
@stsewd
Labels
Accepted Accepted issue on our roadmap Feature New feature
Milestone
YAML File Completion

Comments

@agjohnson
Copy link
Contributor

Add feature for sphinx/mkdocs to fail the build on warnings. This is a config option for both CLI applications, Sphinx has no fail on warning config option, only nitpick options.
@agjohnson agjohnson added Feature New feature Accepted Accepted issue on our roadmap labels Jun 11, 2018
@agjohnson agjohnson added this to the YAML File Completion milestone Jun 11, 2018
@stsewd
Copy link
Member

stsewd commented Jun 11, 2018

mkdocs build:

  -s, --strict                    Enable strict mode. This will cause MkDocs
                                  to abort the build on any warnings.

sphinx-build:

  -W                turn warnings into errors

This was referenced Aug 7, 2018
Merged
Merged
@stsewd
Copy link
Member

stsewd commented Sep 27, 2018

Both related PRs were merged

@stsewd stsewd closed this as completed Sep 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stsewd stsewd

Labels
Accepted Accepted issue on our roadmap Feature New feature
Projects
None yet
Milestone
YAML File Completion
Development

No branches or pull requests
2 participants
@agjohnson @stsewd