Merge pull request #133 from idiap/docs

build: move doc dependencies from extra into group and build with uv

.readthedocs.yml

@@ -9,14 +9,13 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.12"
-
+  commands:
-# Optionally set the version of Python and requirements required to build your docs
+    - asdf plugin add uv
-python:
+    - asdf install uv latest
-  install:
+    - asdf global uv latest
-    - path: .
+    - uv sync --group docs
-      extra_requirements:
+    - uv run -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs/source $READTHEDOCS_OUTPUT/html
-        - docs
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

README.md

@@ -147,9 +147,7 @@ The following extras allow the installation of optional dependencies:
 
 | Name | Description |
 |------|-------------|
-| `all` | All optional dependencies, except `dev` and `docs` |
+| `all` | All optional dependencies |
-| `dev` | Development dependencies |
-| `docs` | Dependencies for building the documentation |
 | `notebooks` | Dependencies only used in notebooks |
 | `server` | Dependencies to run the TTS server |
 | `bn` | Bangla G2P |

docs/requirements.txt

@@ -1,6 +0,0 @@
-furo
-myst-parser == 2.0.0
-sphinx == 7.2.5
-sphinx_inline_tabs
-sphinx_copybutton
-linkify-it-py

pyproject.toml

@@ -77,15 +77,6 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-# Dependencies for building the documentation
-docs = [
-    "furo>=2023.5.20",
-    "myst-parser==2.0.0",
-    "sphinx==7.2.5",
-    "sphinx_inline_tabs>=2023.4.21",
-    "sphinx_copybutton>=0.1",
-    "linkify-it-py>=2.0.0",
-]
 # Only used in notebooks
 notebooks = [
     "bokeh==1.4.0",
@@ -136,6 +127,15 @@ dev = [
     "pre-commit>=3",
     "ruff==0.7.0",
 ]
+# Dependencies for building the documentation
+docs = [
+    "furo>=2023.5.20",
+    "myst-parser==2.0.0",
+    "sphinx==7.2.5",
+    "sphinx_inline_tabs>=2023.4.21",
+    "sphinx_copybutton>=0.1",
+    "linkify-it-py>=2.0.0",
+]
 
 [project.urls]
 Homepage = "https://github.com/idiap/coqui-ai-TTS"