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.

Sign up for GitHub

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

Jump to bottom

Readthedocs build should fail on warnings #304

Open
rgraber opened this issue Apr 27, 2023 · 3 comments
Open

Readthedocs build should fail on warnings #304

rgraber opened this issue Apr 27, 2023 · 3 comments

Comments

@rgraber
Copy link
Contributor

rgraber commented Apr 27, 2023

In order to do this, we should set fail_on_warning: true in .readthedocs.yaml.
Before doing so, however, we need to investigate and resolve the numerous autodoc warnings from the build.
@rgraber rgraber mentioned this issue Apr 27, 2023
Closed
@robrap
Copy link
Contributor

robrap commented Apr 27, 2023

There is a related setting SPHINXOPTS = -W # fail on warnings in the Makefile, as seen here: https://github.com/openedx/open-edx-proposals/blob/8dfc826fc83870c247f22f4c55a3dada0f334c32/Makefile#L5.

@rgraber
Copy link
Contributor Author

rgraber commented Apr 27, 2023

@robrap That's what I was using to test locally

@robrap
Copy link
Contributor

robrap commented Apr 27, 2023

Cool. And if we implement this ticket, noting that both changes should happen in parallel.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rgraber @robrap