Repository navigation
fix: reject unknown docstring parsers in the configuration - #422
Merged
Merged
Conversation
A `parser:` value other than numpy, google or sphinx used to load quietly. A value such as `auto` then turned off RST directive handling and Sphinx normalisation without any message. Loading such a configuration now fails with an error that names the value and lists the supported parsers. An empty `parser:` still means numpy.
📚 Preview this PR's docs locallyFetch the just-built site and open it in your browser: # this exact build
great-docs preview --run 39947353048
# or always the latest build for this PR
great-docs preview --pr 422Auth & tips
|
This file contains hidden or 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
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 PR makes
parser:ingreat-docs.ymlaccept onlynumpy,googleorsphinx. Any other value, including an emptyparser:, stops the build with a one-line error. Before,parser: autowas accepted and silently turned off the RST and Sphinx docstring handling.