Skip to content

Commit

Permalink
[BUGFIX] Fix broken links for SparkDataSet in docs (kedro-org#49)
Browse files Browse the repository at this point in the history
And run `make build-docs` on CircleCI
  • Loading branch information
DmitriiDeriabinQB committed May 30, 2019
1 parent 778eccc commit d05e869
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
6 changes: 6 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,12 @@ jobs:
name: Run all end to end tests
command: |
make e2e-tests
- run:
name: Check docs build on Python 3.6+
command: |
if python -c "import sys; sys.exit(sys.version_info[:2] == (3, 5))" ; then
make build-docs
fi
- run:
name: Check for legal compliance
command: |
Expand Down
2 changes: 1 addition & 1 deletion docs/build-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ rm -rf docs/tmp-build-artifacts/05_api_docs/
rm -rf docs/build
mkdir -p docs/build/html/_static
cp -r docs/source/css docs/build/html/_static
sphinx-build docs/tmp-build-artifacts docs/build/html -c docs/ -E -a -j auto
sphinx-build -c docs/ -W -E -a -j auto docs/tmp-build-artifacts docs/build/html
rm -rf docs/tmp-build-artifacts
4 changes: 2 additions & 2 deletions docs/source/04_user_guide/08_pyspark.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
In this tutorial we explain how to work with `PySpark` in a Kedro pipeline.

Relevant API documentation: [SparkDataSet](/kedro.contrib.io.pyspark)
Relevant API documentation: [SparkDataSet](/kedro.contrib.io.pyspark.SparkDataSet), [SparkJDBCDataSet](/kedro.contrib.io.pyspark.SparkJDBCDataSet)

## Initialising a `SparkSession`

Expand Down Expand Up @@ -58,7 +58,7 @@ Since `SparkSession` is a [singleton](https://python-3-patterns-idioms-test.read

Having created a `SparkSession`, you can load your data using `PySpark`'s [DataFrameReader](https://spark.apache.org/docs/latest/api/python/pyspark.sql.html#pyspark.sql.DataFrameReader).

To do so, please use the provided [SparkDataSet](/kedro.contrib.io.pyspark):
To do so, please use the provided [SparkDataSet](/kedro.contrib.io.pyspark.SparkDataSet):

### Code API

Expand Down

0 comments on commit d05e869

Please sign in to comment.