search

openfisca / openfisca-core

OpenFisca core engine. See other repositories for countries-specific code & data.
https://openfisca.org
GNU Affero General Public License v3.0
168 stars 75 forks source link

Do not treat doc warnings as errors #1134

Closed MattiSG closed 2 years ago

MattiSG commented 2 years ago

This changeset stops documentation compilation warnings from being treated as errors.

An untreatable warning appeared in the codebase since an update to Sphinx (the engine building the doc): <unknown>:1: WARNING: py:obj reference target not found: openfisca_core.types.data_types.arrays.T. Warnings are currently treated as errors when building the doc, meaning that the doc test always fails. For example, this failing CI is now blocking a PR as trivial as #1132.

Applying this changeset implies that additional, legitimate warnings will not be made easily visible in CI. This is however the only way I found after a lot of investigation to solve this situation. See https://github.com/openfisca/openfisca-doc/pull/264#issuecomment-1157868878.

coveralls commented 2 years ago

Coverage Status

Coverage remained the same at 78.94% when pulling bf5efbb62ee2b82588bdb3c6f0d88ca05169d43d on doc-no-error into 7d4933ade3086d7aa9327fc250e1e841236bdffa on master.

MattiSG commented 2 years ago

Thanks to you two!