Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump doc requirements for successful build #226

Merged
merged 1 commit into from
Jul 9, 2024

Conversation

merelcht
Copy link
Member

@merelcht merelcht commented Jul 8, 2024

Description

Fix kedro-org/kedro#3774

Development notes

Updated doc requirements to make sure docs in a new project can be built successfully. Same fix done on the main repo side: kedro-org/kedro#3998

How has this been tested?

Manually created kedro projects and followed the steps outlined in kedro-org/kedro#3774 both with and without examples.

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

Checklist

  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Assigned myself to the PR
  • Added tests to cover my changes

@merelcht merelcht merged commit fb599e7 into main Jul 9, 2024
23 checks passed
@merelcht merelcht deleted the fix/build-docs-new-project branch July 9, 2024 10:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

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