Skip to content

Commit 090c0b7

Browse files
committed
DOC: Add SSLCertVerificationError warning message for documentation build fail
1 parent d4ae649 commit 090c0b7

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/source/development/contributing_documentation.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,13 @@ If you want to do a full clean build, do::
157157
python make.py clean
158158
python make.py html
159159

160+
.. error::
161+
The command ``python make.py html`` requires SSL verification.
162+
If the command exits with an error status.
163+
Try running the command ``python make.py html --num-jobs=1``.
164+
If the terminal output reports a SSLCertVerificationError,
165+
update your local SSL. Then, rerun ``python make.py html``.
166+
160167
You can tell ``make.py`` to compile only a single section of the docs, greatly
161168
reducing the turn-around time for checking your changes.
162169

0 commit comments

Comments
 (0)