watertap-org / watertap

The WaterTAP development repository
https://watertap.readthedocs.io/en/latest
Other
60 stars 59 forks source link

Sphinx build failures due to upstream changes in autogenerated docstrings reST #1042

Closed lbianchi-lbl closed 1 year ago

lbianchi-lbl commented 1 year ago

Description

Expected Behavior

No response

Steps to Reproduce

conda create --yes test-idaes-1191 python=3.10 && conda activate test-idaes-1191
pip install "watertap @ git+https://github.com/watertap-org/watertap@main" rstcheck
pip show pyomo idaes-pse
pip uninstall --yes pyomo idaes-pse && pip install idaes-pse==2.0.0 pyomo=6.5.0 && pip show pyomo idaes-pse
python -c 'from watertap.property_models.cryst_prop_pack import NaClParameterBlock as obj; print(obj.__doc__)' | rstcheck -
# output: Success! No issues detected.
pip uninstall --yes pyomo idaes-pse && pip install "idaes-pse @ git+https://github.com/IDAES/idaes-pse@main" && pip show pyomo idaes-pse
python -c 'from watertap.property_models.cryst_prop_pack import NaClParameterBlock as obj; print(obj.__doc__)' | rstcheck -
# output: <stdin>:17: (WARNING/2) Block quote ends without a blank line; unexpected unindent. Error! Issues detected.

Environment

No response

Anything Else?

No response

lbianchi-lbl commented 1 year ago

This has been fixed upstream, see https://github.com/IDAES/idaes-pse/issues/1191#issuecomment-1572592865 for details.