search

kedro-org / kedro

Kedro is a toolbox for production-ready data science. It uses software engineering best practices to help you create data engineering and data science pipelines that are reproducible, maintainable, and modular.
https://kedro.org
Apache License 2.0
9.48k stars 874 forks source link

Can't build docs in starter - need to update sphinx version #3774

Open Lasica opened 3 months ago

Lasica commented 3 months ago

Description

Can't build docs in starter - need to update sphinx version

Context

Install requirements from the package pip install -e '.[docs]' and try to build docs with sphinx - it's old version and the conf provided requires at least version >5 (plugins).

Steps to Reproduce

kedro new #... enable docs, enter the project
pip install -e '.[docs]'
mkdir docs/_build
python -m sphinx docs/source docs/_build

Expected Result

The docs builds without issues.

Actual Result

It throws an error that sphinx needs to be at version >5.

Your Environment

Kedro 0.19.3, python 3.10, Linux

noklam commented 3 months ago

I see your comment here, are you going to open a PR for this?

Lasica commented 3 months ago

Yes

merelcht commented 1 month ago

Hi @Lasica, are you still interested in creating a PR for this?