diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..e15754c8a --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,45 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.9" + # You can also specify other tool versions: + # nodejs: "20" + # rust: "1.70" + # golang: "1.20" + jobs: + post_create_environment: + # Install poetry + # https://python-poetry.org/docs/#installing-manually + - python -m pip install poetry + post_install: + # Install dependencies with 'docs' dependency group + # https://python-poetry.org/docs/managing-dependencies/#dependency-groups + - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry -C clients/python install --with docs + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: clients/python/docs/conf.py + # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs + # builder: "dirhtml" + # Fail on all warnings to avoid broken references + # fail_on_warning: true +# Optionally build your docs in additional formats such as PDF and ePub +# formats: +# - pdf +# - epub + +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +# python: +# install: +# - requirements: clients/python/docs/requirements.txt +# - method: pip +# path: clients/python diff --git a/clients/python/poetry.lock b/clients/python/poetry.lock index 39bb61f85..f9fd4782e 100644 --- a/clients/python/poetry.lock +++ b/clients/python/poetry.lock @@ -1,4 +1,4 @@ -# This file is automatically @generated by Poetry 1.8.2 and should not be changed by hand. +# This file is automatically @generated by Poetry 1.8.3 and should not be changed by hand. [[package]] name = "absl-py" @@ -1003,7 +1003,6 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, @@ -1729,4 +1728,4 @@ hf = ["huggingface-hub"] [metadata] lock-version = "2.0" python-versions = ">= 3.9, < 3.11" -content-hash = "180a0e1e5cc23b14a761dbf5a102abc0bf50dfee58ebdf478a9d427558b25682" +content-hash = "d401c9afba4135d37a0166471c28814cf909da577a2da922057c96a1702edb09" diff --git a/clients/python/pyproject.toml b/clients/python/pyproject.toml index de4c38f38..e59626107 100644 --- a/clients/python/pyproject.toml +++ b/clients/python/pyproject.toml @@ -25,14 +25,19 @@ requests = { version = "^2.32.2", optional = true } [tool.poetry.extras] hf = ["huggingface-hub"] -[tool.poetry.group.dev.dependencies] +[tool.poetry.group.docs] +optional = true + +[tool.poetry.group.docs.dependencies] sphinx = "^7.2.6" furo = ">=2023.9.10,<2025.0.0" myst-parser = { extras = ["linkify"], version = ">=2,<4" } +sphinx-autobuild = ">=2021.3.14,<2025.0.0" + +[tool.poetry.group.dev.dependencies] pytest = ">=7.4.2,<9.0.0" coverage = { extras = ["toml"], version = "^7.3.2" } pytest-cov = ">=4.1,<6.0" -sphinx-autobuild = ">=2021.3.14,<2025.0.0" ruff = "^0.4.4" mypy = "^1.7.0" testcontainers = "^4.5.0"