docs: manage sphinx stuff via uv (#1162)

KazuCocoa · web-flow · commit df66645ab284 · 2025-08-11T16:31:37.000+09:00
* docs: manage sphinx stuff via uv

* fix uv
diff --git a/docs/Makefile b/docs/Makefile
@@ -4,7 +4,7 @@
 # You can set these variables from the command line, and also
 # from the environment for the first two.
 SPHINXOPTS    ?=
-SPHINXBUILD   ?= sphinx-build
+SPHINXBUILD   ?= uv run sphinx-build
 SOURCEDIR     = .
 BUILDDIR      = _build
 
diff --git a/docs/README.md b/docs/README.md
@@ -2,7 +2,6 @@
 
 ```bash
 $cd python-client/docs
-$pip install -r requirements.txt
 $bash generate.sh
 $cd python-client/docs/_build/html
 $python -m http.server 1234
diff --git a/docs/generate.sh b/docs/generate.sh
@@ -1,4 +1,4 @@
 #!/bin/sh
 rm -rf *rst _build
-sphinx-apidoc -F -H 'Appium python client' -o . ../appium/webdriver
+uv run sphinx-apidoc -F -H 'Appium python client' -o . ../appium/webdriver
 make html
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
 .. Appium python client documentation master file, created by
-   sphinx-quickstart on Sat May 24 20:49:49 2025.
+   sphinx-quickstart on Mon Aug 11 09:34:52 2025.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/pyproject.toml b/pyproject.toml
@@ -48,6 +48,11 @@ dev-dependencies = [
   "python-dateutil~=2.9",
   "ruff~=0.12",
   "types-python-dateutil~=2.9",
+
+  # for documentation
+  "sphinx>=4.0,<9.0",
+  "sphinx_rtd_theme~=3.0",
+  "sphinxcontrib-apidoc~=0.6",
 ]
 
 [build-system]
diff --git a/uv.lock b/uv.lock
