DOC: Add SSLCertVerificationError warning message for documentation b… #62015
Conversation
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
|
Here is a screenshot of the changed section in Contributing to the Documentation, if you chose to merge. 
|
mroeschke
reviewed
Aug 4, 2025
| @@ -157,6 +157,13 @@ If you want to do a full clean build, do:: | |||
| python make.py clean | |||
| python make.py html | |||
|
|
|||
| .. error:: | |||
There was a problem hiding this comment.
Suggested change
| .. error:: | |
| .. tip:: |
mroeschke
reviewed
Aug 4, 2025
Comment on lines
161
to
165
| The command ``python make.py html`` requires SSL verification. | ||
| If the command exits with an error status, | ||
| try running the command ``python make.py html --num-jobs=1``. | ||
| If the terminal output reports a SSLCertVerificationError, | ||
| update your local SSL. Then, rerun ``python make.py html``. |
There was a problem hiding this comment.
Suggested change
| The command ``python make.py html`` requires SSL verification. | |
| If the command exits with an error status, | |
| try running the command ``python make.py html --num-jobs=1``. | |
| If the terminal output reports a SSLCertVerificationError, | |
| update your local SSL. Then, rerun ``python make.py html``. | |
| If``python make.py html`` exits with an error status. | |
| try running the command ``python make.py html --num-jobs=1`` | |
| to identify the cause of the error. |
Making this more generic since the cause of error may not always be SSL related
There was a problem hiding this comment.
Sounds good! I'll make the change.
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.
…uild fail
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.pre-commit run --files doc/source/development/contributing_documentation.rstPASSED locally