Open tlvu opened 3 years ago
The subset-based warnings in Finch tell me that we aren't installing CLISOPS when we build the docs, which is fine, but maybe we haven't properly mocked that library?
For both Raven and Finch, title warning are simple to fix, so that isn't a huge bothersome issue.
For this particular issue:
WARNING: autodoc: failed to import process 'processes.RavenProcess' from module 'raven'; the following exception was raised:
...
TypeError: astuple() should be called on dataclass instances
@richardarsenault was having this problem when building the docs as well. Now that we can see it here, perhaps we can go about tackling it. The culprit appears to be something with dataclasses
; @cjauvin do you know what's going on?
@tlvu I would endorse enabling the fail_on_warning: true
configuration. This needs to be done.
The subset-based warnings in Finch tell me that we aren't installing CLISOPS when we build the docs, which is fine, but maybe we haven't properly mocked that library?
Yeah I think so.
Probably a dupe in https://github.com/Ouranosinc/raven/issues/487
Same "empty processes page" problem was already fixed in https://github.com/Ouranosinc/raven/pull/293 and https://github.com/bird-house/finch/pull/130 but the fix was disabled in commit https://github.com/Ouranosinc/raven/commit/ee99946c58b3c741ca212454dc77dd0919a56697 and commit https://github.com/bird-house/finch/commit/8e0c9914906c52f47ba0725f1be1d7a1cf234dad.
Setting
fail_on_warning: true
will force us to handle all the warnings (more work, annoying) but will let us catch all autodoc warnings that would have failed silently and causing this empty processes page problem (ensure correctness, being proactive).Is there a way for autodoc to fail the build instead of just raising warnings like currently? This way we do not have to set
fail_on_warning: true
but still prevent the "empty processes page" problem.Otherwise I think we have to set
fail_on_warning: true
and be disciplined with ourselves and not let any warnings during doc build.Raven processes page: https://pavics-sdi.readthedocs.io/projects/raven/en/latest/processes.html
Finch processes page: https://pavics-sdi.readthedocs.io/projects/finch/en/latest/processes.html
Raven RtD build failure: https://readthedocs.org/api/v2/build/14935861.txt
Finch RtD build error: https://readthedocs.org/api/v2/build/14808420.txt