Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp docs and add page on IDL-fiasco comparisons #259

Merged
merged 26 commits into from
Feb 17, 2024

Conversation

wtbarnes
Copy link
Owner

@wtbarnes wtbarnes commented Jan 20, 2024

Fixes #255
Fixes #208
Fixes #215

Remaining TODOs

  • Flesh out the atomic database topic guide more
  • Add the fiasco-IDL comparisons as a topic guide page
  • Add the topic guide page to the landing page as a new panel
  • Figure out organization of the panels on the landing page
  • Fix the doctest
  • Add more test files to the database used on RTD

Copy link

codecov bot commented Jan 20, 2024

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (9d531da) 92.63% compared to head (10542c5) 92.30%.

Files Patch % Lines
fiasco/fiasco.py 66.66% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #259      +/-   ##
==========================================
- Coverage   92.63%   92.30%   -0.34%     
==========================================
  Files          38       38              
  Lines        2770     2780      +10     
==========================================
  Hits         2566     2566              
- Misses        204      214      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@wtbarnes wtbarnes marked this pull request as ready for review February 16, 2024 06:59
@wtbarnes
Copy link
Owner Author

The last thing to do is make sure we have all the needed files for computing the rates (ionization and recombination) in the test file list. Currently, the compute rates are not showing up on the rendered docs because those files are missing from the test database.

@wtbarnes wtbarnes mentioned this pull request Feb 17, 2024
@wtbarnes wtbarnes merged commit 0d26448 into main Feb 17, 2024
16 of 18 checks passed
@wtbarnes wtbarnes deleted the idl-comparison-docs-page branch February 17, 2024 01:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inheritance diagrams in docs are broken Add page for fiasco/IDL comparisons Issue with sphinx-book-theme
1 participant