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

Added -keep-going flag to build docs #3140

Merged
merged 3 commits into from
Oct 9, 2023

Conversation

Celsuss
Copy link
Contributor

@Celsuss Celsuss commented Oct 7, 2023

NOTE: Kedro datasets are moving from kedro.extras.datasets to a separate kedro-datasets package in
kedro-plugins repository. Any changes to the dataset implementations
should be done by opening a pull request in that repository.

Description

MR for issue #3132.
Added the --keep-going flag to sphinx-build documentation in build-docs.sh (and by extension make build-docs.
Because all warnings are treated as errors the build will stop if any warnings happens, with this flag the build will still finish despite all the warnings turned errors.
This will hopefully make it a little less for contributors to worry about.

Development notes

All that was changes was the added flag --keep-going.
It's been tested by building the documentation using make build-docs with and without the flag.
With the added flag the build will still finish despite any warnings turned errors.

Checklist

  • Read the contributing guidelines
  • Signed off each commit with a Developer Certificate of Origin (DCO)
  • Opened this PR as a 'Draft Pull Request' if it is work-in-progress
  • Updated the documentation to reflect the code changes
  • Added a description of this change in the RELEASE.md file
  • Added tests to cover my changes
  • Checked if this change will affect Kedro-Viz, and if so, communicated that with the Viz team

Signed-off-by: Jens <jenslorden@gmail.com>
Signed-off-by: Jo Stichbury <jo_stichbury@mckinsey.com>
@stichbury
Copy link
Contributor

This is great, thanks. 🏆

I put a commit in to cherry-pick in a fix to a breaking link that was impacting the RTD build.

Copy link
Contributor

@stichbury stichbury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution @Celsuss 🌟

@ankatiyar ankatiyar added the Community Issue/PR opened by the open-source community label Oct 9, 2023
Copy link
Contributor

@ankatiyar ankatiyar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Celsuss for the contribution! 💯

@ankatiyar ankatiyar merged commit 66acc12 into kedro-org:main Oct 9, 2023
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Community Issue/PR opened by the open-source community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants