Add readthedocs config (#137)

* py: pyproject: create docs group

Signed-off-by: Isabella do Amaral <[email protected]>

* py: add readthedocs config

Signed-off-by: Isabella do Amaral <[email protected]>

---------

Signed-off-by: Isabella do Amaral <[email protected]>

.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

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"