Update libraries used for building documentation and .readthedocs.yml

SDXorg · Sep 22, 2023 · 4d4b9da · 4d4b9da
1 parent e686187
commit 4d4b9da
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 8 deletions.
diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml
@@ -16,7 +16,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: '3.8'
+          python-version: '3.11'
       - name: Install dependencies
         run: |
           pip install .

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -9,8 +9,12 @@ version: 2
 sphinx:
   configuration: docs/conf.py
 
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
 python:
-  version: 3.8
   install:
     - requirements: docs/requirements.txt
     - method: pip

diff --git a/docs/conf.py b/docs/conf.py
@@ -54,7 +54,7 @@
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',
     'sphinx.ext.intersphinx',
-    "sphinx.ext.extlinks"
+    'sphinx.ext.extlinks'
 ]
 
 extlinks = {
@@ -95,7 +95,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,8 +1,8 @@
 # File: docs/requirements.txt
 
-sphinx==4.2.0
-sphinx_rtd_theme==1.0.0
-readthedocs-sphinx-search==0.1.1
-jinja2==3.0.0
+sphinx>=7.0.0
+sphinx_rtd_theme>=1.0.0
+readthedocs-sphinx-search
+jinja2>=3.0.0
 mock
 pandas
diff --git a/docs/whats_new.rst b/docs/whats_new.rst
@@ -26,6 +26,8 @@ Performance
 
 Internal Changes
 ~~~~~~~~~~~~~~~~
+- Update libraries used for building documentation and `.readthedocs.yml` . (`@enekomartinmartinez <https://github.com/enekomartinmartinez>`_)
+
 
 v3.11.0 (2023/08/01)
 --------------------