Merge pull request #2320 from stfc/2242_fix_rtd_builds

(Closes #2242) Update doc configuration to fix RTD builds
stfc · Sep 19, 2023 · 65db1a8 · 65db1a8
2 parents eba697a + 2b82c28
commit 65db1a8
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 8 deletions.
diff --git a/changelog b/changelog
@@ -596,7 +596,9 @@
 
 	201) PR #2148 towards #2105. Adds {Min,Max}Val2Code transformations.
 
-	202) PR 2298 for #1987. Change all intrinsic Operations to IntrinsicCalls.
+	202) PR #2298 for #1987. Change all intrinsic Operations to IntrinsicCalls.
+
+	203) PR #2320 for #2242. Pin Sphinx dependency to <7 to fix RTD building step.
 
 release 2.3.1 17th of June 2022
 

diff --git a/doc/developer_guide/.readthedocs.yaml b/doc/developer_guide/.readthedocs.yaml
@@ -59,6 +59,7 @@ sphinx:
 # need to install the PSyclone package.
 python:
    install:
+     - requirements: doc/developer_guide/pip_requirements.txt
      - method: pip
        path: .
        extra_requirements:

diff --git a/doc/developer_guide/pip_requirements.txt b/doc/developer_guide/pip_requirements.txt
@@ -1,7 +1,7 @@
 # -----------------------------------------------------------------------------
 # BSD 3-Clause License
 #
-# Copyright (c) 2018-2019, Science and Technology Facilities Council.
+# Copyright (c) 2018-2023, Science and Technology Facilities Council.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -35,5 +35,9 @@
 
 # pip requirements file specifying the packages required to build
 # the PSyclone documentation. Used by readthedocs.
-sphinx
+# We have to pin Sphinx to less than version 7 to avoid an incompatibility
+# with the version of sphinx_rtd_theme used by RTD
+# (https://github.com/readthedocs/sphinx_rtd_theme/issues/1463).
+sphinx<7
+sphinx_rtd_theme
 sphinxcontrib.bibtex
diff --git a/doc/reference_guide/.readthedocs.yaml b/doc/reference_guide/.readthedocs.yaml
@@ -59,6 +59,7 @@ sphinx:
 # need to install the PSyclone package.
 python:
    install:
+     - requirements: doc/reference_guide/pip_requirements.txt
      - method: pip
        path: .
        extra_requirements:

diff --git a/doc/reference_guide/pip_requirements.txt b/doc/reference_guide/pip_requirements.txt
@@ -1,7 +1,7 @@
 # -----------------------------------------------------------------------------
 # BSD 3-Clause License
 #
-# Copyright (c) 2018-2019, Science and Technology Facilities Council.
+# Copyright (c) 2018-2023, Science and Technology Facilities Council.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -35,7 +35,10 @@
 
 # pip requirements file specifying the packages required to build
 # the PSyclone documentation. Used by readthedocs.
-sphinx
+# We have to pin Sphinx to less than version 7 to avoid an incompatibility
+# with the version of sphinx_rtd_theme used by RTD
+# (https://github.com/readthedocs/sphinx_rtd_theme/issues/1463).
+sphinx<7
+sphinx_rtd_theme
 sphinxcontrib.bibtex
 autoapi
-sphinx_rtd_theme
diff --git a/doc/user_guide/.readthedocs.yaml b/doc/user_guide/.readthedocs.yaml
@@ -59,6 +59,7 @@ sphinx:
 # need to install the PSyclone package.
 python:
    install:
+     - requirements: doc/user_guide/pip_requirements.txt
      - method: pip
        path: .
        extra_requirements:

diff --git a/doc/user_guide/pip_requirements.txt b/doc/user_guide/pip_requirements.txt
@@ -1,7 +1,7 @@
 # -----------------------------------------------------------------------------
 # BSD 3-Clause License
 #
-# Copyright (c) 2018-2019, Science and Technology Facilities Council.
+# Copyright (c) 2018-2023, Science and Technology Facilities Council.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -35,5 +35,9 @@
 
 # pip requirements file specifying the packages required to build
 # the PSyclone documentation. Used by readthedocs.
-sphinx
+# We have to pin Sphinx to less than version 7 to avoid an incompatibility
+# with the version of sphinx_rtd_theme used by RTD
+# (https://github.com/readthedocs/sphinx_rtd_theme/issues/1463).
+sphinx<7
+sphinx_rtd_theme
 sphinxcontrib.bibtex