search

wtbarnes / fiasco

Python interface to the CHIANTI atomic database
http://fiasco.readthedocs.io/
BSD 3-Clause "New" or "Revised" License
20 stars 15 forks source link

Review documentation #267

Closed wtbarnes closed 2 weeks ago

wtbarnes commented 4 months ago

In #259, I dramatically changed the layout and format of the docs, including implementing a new them. However, there are still some rough edges when it comes to the format of the docs. As an example, there are places where it would be better to suppress one of the navigation sidebars or maybe change the formatting of some of the headings.

Before the next major release, we should do a thorough review of the docs with an eye for formatting.

jwreep commented 1 month ago

Not sure when this happened, but the inheritance diagrams in the docs now appear to be broken.

wtbarnes commented 1 month ago

I think that's only broken on "stable". They appear to still be working on "latest": https://fiasco.readthedocs.io/en/latest/reference/code_ref/io.html#module-fiasco.io.sources. Once I do a release, this will all be fixed on stable as well.

wtbarnes commented 2 weeks ago

A lot of the outstanding issues I had in mind were handled in #286 so I'm going to close this.