IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

[doc] clarify units for `linkcheck_rate_limit_timeout` (#12225)

Browse Source 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>

This normalizes the description of the configuration value so that its default value's unit is the same as the internal one (i.e., seconds).
This commit is contained in:
Nok Lam Chan
2024-04-05 10:51:02 +01:00
committed by GitHub
parent 4b7a2c3f05
commit 17a84a6443
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
doc/usage/configuration.rst
View File

@@ -2939,7 +2939,8 @@ Options for the linkcheck builder
Otherwise, ``linkcheck`` waits for a minute before to retry and keeps
doubling the wait time between attempts until it succeeds or exceeds the
``linkcheck_rate_limit_timeout``. By default, the timeout is 5 minutes.
``linkcheck_rate_limit_timeout``. By default, the timeout is 300 seconds
and custom timeouts should be given in seconds.
.. _Retry-After: https://datatracker.ietf.org/doc/html/rfc7231#section-7.1.3