Skip to content

Commit

Permalink
chore: Hot fix for RTD due to bad pip version (#396)
Browse files Browse the repository at this point in the history
fix RTD

Signed-off-by: Nok <[email protected]>
  • Loading branch information
noklam authored Oct 17, 2023
1 parent b946eec commit 8a5dfb6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
23 changes: 15 additions & 8 deletions kedro-datasets/.readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion kedro-datasets/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down

0 comments on commit 8a5dfb6

Please sign in to comment.