scverse / anndata

Annotated data.
http://anndata.readthedocs.io
BSD 3-Clause "New" or "Revised" License
577 stars 154 forks source link

(dev): Validate `towncrier` fragments. #1622

Closed ilan-gold closed 2 months ago

ilan-gold commented 2 months ago

Please describe your wishes and possible alternatives to achieve the desired result.

We should probably have some sort of test that builds the docs after running towncrier to ensure fragments are valid. Another option would be some sort of myst script to check that the fragment "compiles" without warning (although I don't know enough to say whether or not that is a valid approach).