From 29fa80a070a42de8043ce4998c8bd88216347756 Mon Sep 17 00:00:00 2001 From: FriedrichFroebel Date: Wed, 6 Dec 2023 17:21:13 +0100 Subject: [PATCH 1/3] add extra_requirements to RTD configuration file --- .readthedocs.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2940c9c..45574f7 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,6 +13,8 @@ python: install: - method: pip path: . + extra_requirements: + - docs sphinx: configuration: docs/conf.py From c3158eb4b4d70f4bde27e8fca2c29cb6c67ae83c Mon Sep 17 00:00:00 2001 From: FriedrichFroebel Date: Wed, 6 Dec 2023 17:21:46 +0100 Subject: [PATCH 2/3] add docs dependencies --- pyproject.toml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index 80d0dde..d7096ac 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -46,6 +46,10 @@ dev = [ "flake8 ~= 4.0", "isort ~= 5.10" ] +docs = [ + "sphinx >= 3.5.4", # Latest version with support for Python 3.5 + "sphinx-rtd-theme >= 1.1.1" # Latest version with support for Python 3.5 +] [project.urls] From cac0fa491f33955ba230dc72699cadf6d9bf1d79 Mon Sep 17 00:00:00 2001 From: FriedrichFroebel Date: Wed, 6 Dec 2023 17:22:14 +0100 Subject: [PATCH 3/3] fix deprecated configuration syntax --- docs/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index fb69b80..018d658 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -76,7 +76,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" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -296,7 +296,7 @@ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {"https://docs.python.org/": None} +intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} # -- Options for autodoc -----------------------------------------------