search

villano-lab / nrCascadeSim

calculating the NR spectrum resulting from neutron-capture cascades.
MIT License
0 stars 1 forks source link

Include the fail-on-warning option for sphinx/readthedocs #41

Closed villaa closed 2 years ago

villaa commented 2 years ago

I am submitting a documentation issue.

The file(s) in question is/are: .readthedocs.yaml

The problem is in the following category/categories: Currently we explicitly do not fail the documentation build on readthedocs when a warning happens. There are known to be currently 9 warnings with the documentation build.

Description of the problem: We can address those warnings and add back the stanza:

sphinx:
   configuration: docs/source/conf.py
   fail_on_warning: true

in order to test the docs building more stringently.

villaa commented 2 years ago

Addressed by PR #62