volkamerlab / opencadd

A Python library for structural cheminformatics
https://opencadd.readthedocs.io
MIT License
91 stars 18 forks source link

Fix docs CI fails #137

Closed dominiquesydow closed 2 years ago

dominiquesydow commented 2 years ago

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

codecov-commenter commented 2 years ago

Codecov Report

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

dominiquesydow commented 2 years ago

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 :)