chore: Hot fix for RTD due to bad pip version (kedro-org#396)

fix RTD Signed-off-by: Nok <[email protected]> Signed-off-by: tgoelles <[email protected]>
tgoelles · Jun 6, 2024 · b41cd20 · b41cd20
1 parent c4d2c18
commit b41cd20
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 9 deletions.
diff --git a/kedro-datasets/.readthedocs.yaml b/kedro-datasets/.readthedocs.yaml
@@ -10,21 +10,28 @@ build:
   tools:
     python: "3.8"
   jobs:
+    pre_install:
+    # pip==23.2 breaks pip-tools<7.0, and pip-tools>=7.0 does not support Python 3.7
+    # pip==23.3 breaks dependency resolution
+      - python -m pip install -U "pip>=21.2,<23.2"
+    # These are technically installation steps, due to RTD's limit we need to inject the installation earlier.
+      - python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext
+      - python -m pip install --upgrade --upgrade-strategy only-if-needed --no-cache-dir ./kedro-datasets[docs,test]
     pre_build:
       - pip freeze
       - python -m sphinx -WETan -j auto -D language=en -b linkcheck -d kedro-datasets/_build/doctrees kedro-datasets/docs/source kedro-datasets/_build/linkcheck
-
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   builder: html
   configuration: kedro-datasets/docs/source/conf.py
   fail_on_warning: true
 
+# TODO: Revert the hot fix with `pre_install` when pip release a better version.
 # Optionally set the version of Python and requirements required to build your docs
-python:
-  install:
-    - method: pip
-      path: kedro-datasets
-      extra_requirements:
-        - docs
-        - test
+# python:
+#   install:
+#     - method: pip
+#       path: kedro-datasets
+#       extra_requirements:
+#         - docs
+#         - test
diff --git a/kedro-datasets/pyproject.toml b/kedro-datasets/pyproject.toml
@@ -31,7 +31,7 @@ version = {attr = "kedro_datasets.__version__"}
 [tool.coverage.report]
 fail_under = 100
 show_missing = true
-omit = ["tests/*", "kedro_datasets/holoviews/*", "kedro_datasets/snowflake/*", "kedro_datasets/tensorflow/*"]
+omit = ["tests/*", "kedro_datasets/holoviews/*", "kedro_datasets/snowflake/*", "kedro_datasets/tensorflow/*", "kedro_datasets/__init__.py"]
 exclude_lines = ["pragma: no cover", "raise NotImplementedError"]
 
 [tool.pytest.ini_options]