Merge pull request #4123 from vivodi/doc

Separate doc dependencies
Flexget · Jan 8, 2025 · 5fe0969 · 5fe0969
2 parents 94e8313 + f05eda5
commit 5fe0969
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 86 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -25,7 +25,10 @@ repos:
       - id: uv-export
         args: [ --frozen, --no-hashes, --only-group=transmission, --output-file=requirements/transmission.txt ]
       - id: uv-export
-        args: [ --frozen, --no-hashes, --no-emit-project, --output-file=requirements-dev.txt ]
+        args: [ --frozen, --no-hashes, --only-group=docs, --output-file=requirements/docs.txt ]
+      # `requirements/dev.txt` is never used in the project. It is just prepared for developers who do not want to use uv.
+      - id: uv-export
+        args: [ --frozen, --no-hashes, --no-emit-project, --output-file=requirements/dev.txt ]
   - repo: https://github.com/renovatebot/pre-commit-hooks
     rev: 39.91.4
     hooks:

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -22,6 +22,6 @@ sphinx:
 # Optionally declare the Python requirements required to build your docs
 python:
    install:
-   - requirements: requirements-dev.txt
+   - requirements: requirements/docs.txt
    - method: pip
      path: .
diff --git a/pyproject.toml b/pyproject.toml
@@ -56,18 +56,18 @@ dependencies = [
 dev = [
     "codacy-coverage ~=1.3",
     "coverage ~=7.6",
-    "docutils ~=0.21.2",
     "pre-commit ~=4.0",
     "pytest ~=8.3",
     "pytest-cov ~=6.0",
     "pytest-runner ~=6.0",
     "pytest-xdist ~=3.6",
     "ruff ~=0.8.4",
-    # TODO: remove this after we drop python 3.9
-    "sphinx ~=7.4; python_version == '3.9'",
-    "sphinx ~=8.1; python_version >= '3.10'",
     "vcrpy ~=7.0",
 ]
+docs = [
+    # TODO: remove python_version after we drop python 3.9
+    "sphinx ~=8.1; python_version >= '3.10'"
+]
 plugin-test = [
     # These are optional dependencies for plugins that have tests in the test suite
     "boto3 ~=1.35",

diff --git a/requirements-dev.txt → requirements/dev.txt b/requirements-dev.txt → requirements/dev.txt
@@ -1,12 +1,9 @@
 # This file was autogenerated by uv via the following command:
-#    uv export --frozen --no-hashes --no-emit-project --output-file=requirements-dev.txt
-alabaster==0.7.16 ; python_full_version < '3.10'
-alabaster==1.0.0 ; python_full_version >= '3.10'
+#    uv export --frozen --no-hashes --no-emit-project --output-file=requirements/dev.txt
 aniso8601==9.0.1
 apscheduler==3.11.0
 attrs==24.3.0
 autocommand==2.2.2
-babel==2.16.0
 babelfish==0.6.0 ; python_full_version < '3.10'
 babelfish==0.6.1 ; python_full_version >= '3.10'
 backports-tarfile==1.2.0 ; python_full_version < '3.12'
@@ -25,7 +22,6 @@ codacy-coverage==1.3.11
 colorama==0.4.6
 coverage==7.6.10
 distlib==0.3.9
-docutils==0.21.2
 exceptiongroup==1.2.2 ; python_full_version < '3.11'
 execnet==2.1.1
 feedparser==6.0.11
@@ -40,7 +36,6 @@ guessit==3.8.0
 html5lib==1.1
 identify==2.6.5
 idna==3.10
-imagesize==1.4.1
 importlib-metadata==8.5.0 ; python_full_version < '3.10'
 importlib-resources==6.5.2
 iniconfig==2.0.0
@@ -91,16 +86,7 @@ ruff==0.8.6
 setuptools==75.7.0
 sgmllib3k==1.0.0
 six==1.17.0
-snowballstemmer==2.2.0
 soupsieve==2.6
-sphinx==7.4.7 ; python_full_version < '3.10'
-sphinx==8.1.3 ; python_full_version >= '3.10'
-sphinxcontrib-applehelp==2.0.0
-sphinxcontrib-devhelp==2.0.0
-sphinxcontrib-htmlhelp==2.1.0
-sphinxcontrib-jsmath==1.0.1
-sphinxcontrib-qthelp==2.0.0
-sphinxcontrib-serializinghtml==2.0.0
 sqlalchemy==2.0.36
 tempora==5.8.0
 time-machine==2.16.0 ; implementation_name != 'pypy'

diff --git a/requirements/docs.txt b/requirements/docs.txt
@@ -0,0 +1,25 @@
+# This file was autogenerated by uv via the following command:
+#    uv export --frozen --no-hashes --only-group=docs --output-file=requirements/docs.txt
+alabaster==1.0.0 ; python_full_version >= '3.10'
+babel==2.16.0 ; python_full_version >= '3.10'
+certifi==2024.12.14 ; python_full_version >= '3.10'
+charset-normalizer==3.4.1 ; python_full_version >= '3.10'
+colorama==0.4.6 ; python_full_version >= '3.10' and sys_platform == 'win32'
+docutils==0.21.2 ; python_full_version >= '3.10'
+idna==3.10 ; python_full_version >= '3.10'
+imagesize==1.4.1 ; python_full_version >= '3.10'
+jinja2==3.1.5 ; python_full_version >= '3.10'
+markupsafe==3.0.2 ; python_full_version >= '3.10'
+packaging==24.2 ; python_full_version >= '3.10'
+pygments==2.19.0 ; python_full_version >= '3.10'
+requests==2.32.3 ; python_full_version >= '3.10'
+snowballstemmer==2.2.0 ; python_full_version >= '3.10'
+sphinx==8.1.3 ; python_full_version >= '3.10'
+sphinxcontrib-applehelp==2.0.0 ; python_full_version >= '3.10'
+sphinxcontrib-devhelp==2.0.0 ; python_full_version >= '3.10'
+sphinxcontrib-htmlhelp==2.1.0 ; python_full_version >= '3.10'
+sphinxcontrib-jsmath==1.0.1 ; python_full_version >= '3.10'
+sphinxcontrib-qthelp==2.0.0 ; python_full_version >= '3.10'
+sphinxcontrib-serializinghtml==2.0.0 ; python_full_version >= '3.10'
+tomli==2.2.1 ; python_full_version == '3.10.*'
+urllib3==1.26.20 ; python_full_version >= '3.10'
diff --git a/uv.lock b/uv.lock