The RTD page of this package is a mess. Docstrings are sometimes alright but could also be improved.
Just to list a few things:
- There are two pages named "Database" in the TOC, with very similar content
- The landing page has some formatting issues (":::{warning}")
- The "Getting Started" page could use some more visual examples
- The "speXtra workflow" page is a joke
- Various download progress bars look ugly
- The "Basics" page has some useful info, probably the most. But it's a bit hidden and perhaps some of that could be moved to the docstings of the relevant methods as examples. Also it's broken because it throw a
TypeError further down (why is this not reported as failing the docs build??).
- The "Data Directory" page seems lost. Also not sure how accurate the information there still is anyway...
- The "Changelog" should either be updated to directly use the root CHANGELOG file or just be removed entirely and refer to the GitHub releases page instead.
In general it seems this is a mix of notebooks and "normal pages". I'd suggest moving everything to markdown (myst) based format, there are no real "large scale full science case" examples as in e.g. ScopeSim.
The various "Spectral Libraries"/"Extinction Curves"/"Filters" are a good idea in principle, but currently unreadable. This is a somewhat larger issue that should be tackled separately.
The RTD page of this package is a mess. Docstrings are sometimes alright but could also be improved.
Just to list a few things:
TypeErrorfurther down (why is this not reported as failing the docs build??).In general it seems this is a mix of notebooks and "normal pages". I'd suggest moving everything to markdown (myst) based format, there are no real "large scale full science case" examples as in e.g. ScopeSim.
The various "Spectral Libraries"/"Extinction Curves"/"Filters" are a good idea in principle, but currently unreadable. This is a somewhat larger issue that should be tackled separately.