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

Note: Docs CI warnings not turned into errors anymore #220

Open
dominiquesydow opened this issue Mar 28, 2022 · 0 comments
Open

Note: Docs CI warnings not turned into errors anymore #220

dominiquesydow opened this issue Mar 28, 2022 · 0 comments

Comments

@dominiquesydow
Copy link
Collaborator

This issue summarizes changes made to the docs CI.

A subset of notebooks shows docs build warnings, which were turned into errors in the docs CI, although the generated HTMLs look fine.

Example:

/home/runner/work/teachopencadd/teachopencadd/docs/talktorials/T008_query_pdb.nblink:15: ERROR: Content block expected for the "raw" directive; none found.

https://github.com/volkamerlab/teachopencadd/runs/5728279025?check_suite_focus=true#step:8:36

I do not understand what is wrong - the output looks fine. If someone has an idea how to fix the root of this warning, please let me/us know.

For the time being: Warnings are not turned into errors any more as of #217, so that the docs CI stops to fail: (remove -W from SPHINXOPTS, see here): https://www.sphinx-doc.org/en/master/man/sphinx-build.html#cmdoption-sphinx-build-W

Revisit this if we do find issues with the HTML rendering.

Related issue: vladris/tinkerer#40

@dominiquesydow dominiquesydow changed the title Docs CI warnings not turned into errors anymore Note: Docs CI warnings not turned into errors anymore Dec 27, 2022
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

No branches or pull requests

1 participant