Skip to content

Commit

Permalink
Add Read the Docs configuration for kedro-datasets
Browse files Browse the repository at this point in the history
Signed-off-by: Juan Luis Cano Rodríguez <juan_luis_cano@mckinsey.com>
  • Loading branch information
astrojuanlu committed Aug 14, 2023
1 parent a28a3aa commit 72871dc
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions kedro-datasets/.readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# .readthedocs.yml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.8"
jobs:
pre_build:
- pip freeze
- python -m sphinx -WETan -j auto -D language=en -b linkcheck -d _build/doctrees docs/source _build/linkcheck

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
configuration: docs/source/conf.py
fail_on_warning: true

# Optionally set the version of Python and requirements required to build your docs
python:
install:
- method: pip
path: kedro-datasets
extra_requirements:
- docs
- test

0 comments on commit 72871dc

Please sign in to comment.