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

Fix docs CI fails #137

Merged
merged 8 commits into from
Jan 10, 2022
Merged

Fix docs CI fails #137

merged 8 commits into from
Jan 10, 2022

Conversation

dominiquesydow
Copy link
Contributor

@dominiquesydow dominiquesydow commented Jan 9, 2022

Description

Currently, our docs CI fails (docs can be built locally though) due to some warnings:

Not quite sure if all warnings lead to the CI fail or only the docs notebook - fix all of them anyways :)

Todos

Status

  • Ready to go

@dominiquesydow dominiquesydow self-assigned this Jan 9, 2022
@codecov-commenter
Copy link

codecov-commenter commented Jan 9, 2022

Codecov Report

Merging #137 (f79a3aa) into master (37714e6) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@dominiquesydow
Copy link
Contributor Author

dominiquesydow commented Jan 9, 2022

Alternative: Do not turn warnings into errors in our docs CI.

Check our RTD config: Does not fail on warnings (compare to RTD docs)

Sync this behaviour with our docs CI? Remove -W --keep-going:
https://github.com/volkamerlab/opencadd/blob/master/.github/workflows/ci.yaml#L154

Check out sphinx options:
https://www.sphinx-doc.org/en/master/man/sphinx-build.html#options

EDIT: Dropped this alternative - better to be made aware of errors big time and fix them :)

@dominiquesydow dominiquesydow changed the title Pin setuptools to fix docs CI fail Fix docs CI fails Jan 9, 2022
@dominiquesydow dominiquesydow mentioned this pull request Jan 10, 2022
@dominiquesydow dominiquesydow merged commit 93d6666 into master Jan 10, 2022
@dominiquesydow dominiquesydow deleted the pin-setuptools branch January 10, 2022 23:42
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.

2 participants