According to the badge displayed in the README file (see screenshot), ReadTheDocs currently fails to build our docs.
When building the docs locally, I notice there is a warning
snewpy/python/snewpy/models/presn.py:docstring of snewpy.models.presn.Patton_2017:10: WARNING: Duplicate explicit target name: "zenodo".
and RTD appears to treat warnings as errors in its builds. (Which is arguably a good practice.)
The intermediate fix to eliminate this warning is to turn the links into anonymous references; but to avoid similar things happening again, we should also do the following:
[ ] treat warnings as errors in our docs Makefile
[ ] build docs as part of our CI workflows
I’ve started working on this & will try to get a PR out on Friday. Would be good to get this in ASAP (before releasing v1.5), so we have docs available as soon as the release is published.
According to the badge displayed in the README file (see screenshot), ReadTheDocs currently fails to build our docs.
When building the docs locally, I notice there is a warning
snewpy/python/snewpy/models/presn.py:docstring of snewpy.models.presn.Patton_2017:10: WARNING: Duplicate explicit target name: "zenodo".and RTD appears to treat warnings as errors in its builds. (Which is arguably a good practice.)The intermediate fix to eliminate this warning is to turn the links into anonymous references; but to avoid similar things happening again, we should also do the following:
I’ve started working on this & will try to get a PR out on Friday. Would be good to get this in ASAP (before releasing v1.5), so we have docs available as soon as the release is published.