rice-solar-physics/ebtelplusplus

API reference for unit annotations on dataclasses (e.g. `EbtelResult`) do not render nicely

開放

#125 建立於 2025年9月6日

 (1 則留言) (0 個反應) (0 位負責人)Python (7 個分叉)auto 404
CIbug?docshelp wanted

倉庫指標

星標
 (13 顆星)
PR 合併指標
 (30 天內沒有已合併 PR)

描述

The way dataclasses handle type/unit annotations must have changed in Python 3.12 because the API documentation no longer renders the unit annotations correctly, e.g. https://ebtelplusplus.readthedocs.io/en/latest/api/ebtelplusplus.EbtelResult.html#ebtelplusplus.EbtelResult.tr_corona_radiative_loss_ratio. Furthermore, the docs build on GitHub Actions is now failing because of a warning about an unfound reference for u.dimensionless_unscaled.

This should be addressed before a new release is cut.

貢獻者指南