From 090c0b73d9acc87bd04a37309b396df9a07e576e Mon Sep 17 00:00:00 2001 From: jeffersbaxter Date: Thu, 31 Jul 2025 14:35:14 -0700 Subject: [PATCH 1/3] DOC: Add SSLCertVerificationError warning message for documentation build fail --- doc/source/development/contributing_documentation.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/source/development/contributing_documentation.rst b/doc/source/development/contributing_documentation.rst index 443470e6c50f9..1584faae9562a 100644 --- a/doc/source/development/contributing_documentation.rst +++ b/doc/source/development/contributing_documentation.rst @@ -157,6 +157,13 @@ If you want to do a full clean build, do:: python make.py clean python make.py html +.. error:: + 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``. + You can tell ``make.py`` to compile only a single section of the docs, greatly reducing the turn-around time for checking your changes. From 9c5b2d3d8de1eba046bbcf4f8cbda7f791253c7e Mon Sep 17 00:00:00 2001 From: jeffersbaxter Date: Sat, 2 Aug 2025 21:55:06 -0700 Subject: [PATCH 2/3] fixed type in SSLCertVerificationError message on contributing to documentation page --- doc/source/development/contributing_documentation.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/development/contributing_documentation.rst b/doc/source/development/contributing_documentation.rst index 1584faae9562a..a3cd2bd27e337 100644 --- a/doc/source/development/contributing_documentation.rst +++ b/doc/source/development/contributing_documentation.rst @@ -159,8 +159,8 @@ If you want to do a full clean build, do:: .. error:: 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 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``. From b5d26dd43bc95399c64b9bdf5c6c1e399d498c64 Mon Sep 17 00:00:00 2001 From: jeffersbaxter Date: Mon, 4 Aug 2025 19:08:02 -0700 Subject: [PATCH 3/3] change documentation build ssl error to generic tip --- doc/source/development/contributing_documentation.rst | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/doc/source/development/contributing_documentation.rst b/doc/source/development/contributing_documentation.rst index a3cd2bd27e337..8e00d5c1315f5 100644 --- a/doc/source/development/contributing_documentation.rst +++ b/doc/source/development/contributing_documentation.rst @@ -157,12 +157,10 @@ If you want to do a full clean build, do:: python make.py clean python make.py html -.. error:: - 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``. +.. tip:: + 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. You can tell ``make.py`` to compile only a single section of the docs, greatly reducing the turn-around time for checking your changes.