Skip to content

Commit

Permalink
Try adding docs rtd check on kedro datasets
Browse files Browse the repository at this point in the history
Signed-off-by: Merel Theisen <[email protected]>
  • Loading branch information
merelcht committed Aug 10, 2023
1 parent ce957f1 commit 5d118fb
Show file tree
Hide file tree
Showing 16 changed files with 1,414 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .github/workflows/check-plugin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,10 @@ jobs:
if: matrix.os == 'windows-latest' && inputs.plugin == 'kedro-datasets' && matrix.python-version != '3.10'
run: |
make test-no-spark
- name: RTD build for kedro-datasets
if: inputs.plugin == 'kedro-datasets' && matrix.python-version == '3.10'
run: |
make rtd
lint:
defaults:
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/run-docs-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Run Doc builds on Kedro-Datasets

on:
push:
branches:
- main
- try-rtd-build
paths-ignore:
- "kedro-airflow/**"
- "kedro-docker/**"
- "kedro-telemetry/**"
pull_request:
branches:
- main
- try-rtd-build
paths-ignore:
- "kedro-airflow/**"
- "kedro-docker/**"
- "kedro-telemetry/**"

jobs:
datasets-test:
uses: ./.github/workflows/check-plugin.yml
with:
plugin: kedro-datasets
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -60,3 +60,6 @@ test-no-spark-sequential:
# kedro-datasets/snowflake tests skipped from default scope
test-snowflake-only:
cd kedro-datasets && pytest tests --no-cov --numprocesses 1 --dist loadfile -m snowflake

rtd:
cd kedro-datasets && python -m sphinx -WETan -j auto -D language=en -b linkcheck -d _build/doctrees docs/source _build/linkcheck
14 changes: 14 additions & 0 deletions kedro-datasets/docs/build-docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/usr/bin/env bash

set -e

# Exit script if you try to use an uninitialized variable.
set -o nounset

action=$1

if [ "$action" == "linkcheck" ]; then
sphinx-build -WETan -j auto -D language=en -b linkcheck -d docs/build/doctrees docs/source docs/build/linkcheck
elif [ "$action" == "docs" ]; then
sphinx-build -WETa -j auto -D language=en -b html -d docs/build/doctrees docs/source docs/build/html
fi
Loading

0 comments on commit 5d118fb

Please sign in to comment.