From ec18e7efc449820b8f8c98360264ce8a7cb6093a Mon Sep 17 00:00:00 2001 From: tdruez Date: Mon, 29 Dec 2025 16:00:06 +0400 Subject: [PATCH 1/4] Update the readthedocs config to fix the build Signed-off-by: tdruez --- .readthedocs.yaml | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e586da0e..7dfd9678 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,14 +6,17 @@ version: 2 # Set the OS, Python version and other tools you might need build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: python: "3.13" -# Optionally declare the Python requirements required to build your docs +# Extra requirements section to install in addition to the package dependencies python: - install: - - requirements: docs/requirements.txt + install: + - method: pip + path: . + extra_requirements: + - docs # Build documentation in the "docs/" directory with Sphinx sphinx: From abc1586fe5f2a6aaaee67bb8ba7657395dc8e062 Mon Sep 17 00:00:00 2001 From: tdruez Date: Mon, 29 Dec 2025 16:05:54 +0400 Subject: [PATCH 2/4] Update the readthedocs config to fix the build Signed-off-by: tdruez --- .readthedocs.yaml | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7dfd9678..2066608f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,14 +9,9 @@ build: os: ubuntu-24.04 tools: python: "3.13" - -# Extra requirements section to install in addition to the package dependencies -python: - install: - - method: pip - path: . - extra_requirements: - - docs + jobs: + post_install: + - pip install .[docs] --no-deps # installs only the extras, not the package deps # Build documentation in the "docs/" directory with Sphinx sphinx: From 48390ee001adbe9997a76353e7135bb7d71a9856 Mon Sep 17 00:00:00 2001 From: tdruez Date: Mon, 29 Dec 2025 16:07:53 +0400 Subject: [PATCH 3/4] Update the readthedocs config to fix the build Signed-off-by: tdruez --- .readthedocs.yaml | 2 +- Makefile | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2066608f..6de0ff87 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,7 +11,7 @@ build: python: "3.13" jobs: post_install: - - pip install .[docs] --no-deps # installs only the extras, not the package deps + - make doc_dependencies # Build documentation in the "docs/" directory with Sphinx sphinx: diff --git a/Makefile b/Makefile index 279fc0d1..4c328dd2 100644 --- a/Makefile +++ b/Makefile @@ -59,7 +59,7 @@ envfile_dev: envfile @echo DATABASE_PASSWORD=\"dejacode\" >> ${ENV_FILE} doc_dependencies: virtualenv - @echo "-> Configure and install decumentation dependencies" + @echo "-> Configure and install documentation dependencies" @${ACTIVATE} pip install --editable .[docs] doc8: From f8569d5b1b818e3f8729c369f6d12954fd1deeed Mon Sep 17 00:00:00 2001 From: tdruez Date: Mon, 29 Dec 2025 16:15:34 +0400 Subject: [PATCH 4/4] Update the readthedocs config to fix the build Signed-off-by: tdruez --- .readthedocs.yaml | 2 +- docs/conf.py | 2 +- pyproject.toml | 6 +++--- .../dist/sphinx-8.1.3-py3-none-any.whl.ABOUT | 14 -------------- 4 files changed, 5 insertions(+), 19 deletions(-) delete mode 100644 thirdparty/dist/sphinx-8.1.3-py3-none-any.whl.ABOUT diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6de0ff87..bd1eb5ae 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,7 +11,7 @@ build: python: "3.13" jobs: post_install: - - make doc_dependencies + - pip install --upgrade furo # Build documentation in the "docs/" directory with Sphinx sphinx: diff --git a/docs/conf.py b/docs/conf.py index b1374f5b..063a4651 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,7 +17,7 @@ extensions = [] templates_path = ["_templates"] -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "installation_and_sysadmin"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/pyproject.toml b/pyproject.toml index 7abc85ff..df47ddf1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -171,9 +171,9 @@ dev = [ "tblib==3.1.0" ] docs = [ - "Sphinx==8.2.3", - "furo==2025.9.25", - "doc8==2.0.0", + "Sphinx", + "furo", + "doc8", ] [project.urls] diff --git a/thirdparty/dist/sphinx-8.1.3-py3-none-any.whl.ABOUT b/thirdparty/dist/sphinx-8.1.3-py3-none-any.whl.ABOUT deleted file mode 100644 index f3ca2377..00000000 --- a/thirdparty/dist/sphinx-8.1.3-py3-none-any.whl.ABOUT +++ /dev/null @@ -1,14 +0,0 @@ -about_resource: sphinx-8.1.3-py3-none-any.whl -name: sphinx -version: 8.1.3 -download_url: https://files.pythonhosted.org/packages/26/60/1ddff83a56d33aaf6f10ec8ce84b4c007d9368b21008876fceda7e7381ef/sphinx-8.1.3-py3-none-any.whl -package_url: pkg:pypi/sphinx@8.1.3 -license_expression: bsd-new -copyright: Copyright sphinx project contributors -attribute: yes -checksum_md5: 3bcca8b62843f94429276a0bf1c90c28 -checksum_sha1: 67dc18611c44f712539585db41aaee4b0a7ec646 -licenses: - - key: bsd-new - name: BSD-3-Clause - file: bsd-new.LICENSE