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 合并指标
 (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.

贡献者指南