search

openedx / edx-django-utils

edX utilities for Django Application development.
https://edx.readthedocs.io/projects/edx-django-utils/en/latest/
Apache License 2.0
26 stars 21 forks source link

Readthedocs build should fail on warnings #304

Open rgraber opened 1 year ago

rgraber commented 1 year ago

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.

robrap commented 1 year ago

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 commented 1 year ago

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

robrap commented 1 year ago

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