rice-solar-physics/ebtelplusplus

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

Open

#125 opened on Sep 6, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (7 forks)auto 404
CIbug?docshelp wanted

Repository metrics

Stars
 (13 stars)
PR merge metrics
 (PR metrics pending)

Description

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.

Contributor guide

Research direction
Investigate how Sphinx or the documentation tool processes dataclass unit annotations, particularly focusing on changes in Python 3.12. Check the documentation configuration and see if custom processing is needed.
Tech stack
python
Domain
documentation
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60