Merge branch 'diataxis/main' of github.com:readthedocs/readthedocs.org into diataxis/integration-is-a-howto

Author: benjaoming

docs/Makefile

@@ -2,7 +2,12 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    =
+
+# Options should be aligned with how the documentation is built on RTD
+# (except for '--keep-going', failing fast is prefered on local builds)
+# We also remove '-E' to reduce the time of rebuilding reference indexes
+# on each build.
+SPHINXOPTS    = -T -j auto -W
 SPHINXBUILD   = sphinx-build
 PAPER         =
 PROJECT       ?= user

requirements/docs.in

@@ -3,18 +3,22 @@
 -r pip.txt
 
 sphinx_rtd_theme==1.1.0
+# Note: Version 3.4.1 of sphinx-tabs requires docutils 0.18 which is yet to be supported by sphinx-rtd-theme
+# Version 3.4.0 has an incompatible Jinja2 version which also blocks sphinx-rtd-theme
+# All-together, we cannot upgrade to Sphinx 5.x before either sphinx-tabs or sphinx-rtd-theme fixes these
+# issues.
 sphinx-tabs==3.3.1
 sphinx-intl==2.0.1
 sphinx-design==0.2.0
 sphinx-multiproject==1.0.0rc1
-readthedocs-sphinx-search==0.1.1
+readthedocs-sphinx-search==0.1.2
 
 # Test out hoverxref
 git+https://github.com/readthedocs/sphinx-hoverxref
 
 # Docs
 sphinxemoji==0.2.0
-sphinxcontrib-httpdomain==1.8.0
+sphinxcontrib-httpdomain==1.8.1
 sphinxcontrib-mermaid>=0.7.1,<0.8
 sphinx-prompt==1.4.0
 sphinx-notfound-page==0.8

requirements/docs.txt

@@ -1,6 +1,6 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
-# by the following command:
+# This file is autogenerated by pip-compile with python 3.10
+# To update, run:
 #
 #    pip-compile requirements/docs.in
 #
@@ -305,7 +305,7 @@ pyyaml==5.4.1
     # via
     #   -r requirements/pip.txt
     #   myst-parser
-readthedocs-sphinx-search==0.1.1
+readthedocs-sphinx-search==0.1.2
     # via -r requirements/docs.in
 redis==3.5.3
     # via -r requirements/pip.txt
@@ -397,7 +397,7 @@ sphinxcontrib-htmlhelp==2.0.0
     # via
     #   -r requirements/pip.txt
     #   sphinx
-sphinxcontrib-httpdomain==1.8.0
+sphinxcontrib-httpdomain==1.8.1
     # via -r requirements/docs.in
 sphinxcontrib-jquery==3.0.0
     # via sphinx-hoverxref