Skip to content

DOC: Add SSLCertVerificationError warning message for documentation b… #62015

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

Merged
merged 5 commits into from
Aug 5, 2025
Merged

DOC: Add SSLCertVerificationError warning message for documentation b… #62015

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
090c0b7
DOC: Add SSLCertVerificationError warning message for documentation b…
jeffersbaxter Jul 31, 2025
94716b5
resolved merge from main for ssl error pr for doc build page
jeffersbaxter Aug 3, 2025
9c5b2d3
fixed type in SSLCertVerificationError message on contributing to doc…
jeffersbaxter Aug 3, 2025
dfc7f71
updated documentation build branch with commits from upstream/main
jeffersbaxter Aug 5, 2025
b5d26dd
change documentation build ssl error to generic tip
jeffersbaxter Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions doc/source/development/contributing_documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,13 @@ If you want to do a full clean build, do::
python make.py clean
python make.py html

.. error::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. error::
.. tip::

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``.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good! I'll make the change.


You can tell ``make.py`` to compile only a single section of the docs, greatly
reducing the turn-around time for checking your changes.

Expand Down
Loading