API documents need cleaning up

BrownDwarf / gollum

A microservice for programmatic access to precomputed synthetic spectral model grids in astronomy

https://gollum-astro.readthedocs.io/

MIT License

20 stars 5 forks source link

API documents need cleaning up #113

Closed rhdtownsend closed 3 months ago

rhdtownsend commented 4 months ago

The API docs have seen quite a bit of improvement since I began reviewing gollum, but still need some tidying up. For instance, there is a bogus "PHOENIX Spectrum" header at the top of the class list.

Review link: https://github.com/openjournals/joss-reviews/issues/6601

Sujay-Shankar commented 3 months ago

The most recent commits should have fixed the extra headers appearing in the documentation pages, instead replaced by module-specific headers for PHOENIX, Sonora, etc. Are there any other issues that stand out in the documentation?