Make docs use autogenerated BSEDicts rather than manual ones#744
Merged
TomWagg merged 8 commits intoCOSMIC-PopSynth:developfrom Feb 4, 2026
Merged
Make docs use autogenerated BSEDicts rather than manual ones#744TomWagg merged 8 commits intoCOSMIC-PopSynth:developfrom
TomWagg merged 8 commits intoCOSMIC-PopSynth:developfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #744 +/- ##
===========================================
- Coverage 86.91% 77.82% -9.09%
===========================================
Files 40 50 +10
Lines 25542 27436 +1894
Branches 0 920 +920
===========================================
- Hits 22198 21350 -848
- Misses 3344 5812 +2468
- Partials 0 274 +274 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
MarkGM02
pushed a commit
to MarkGM02/COSMIC
that referenced
this pull request
Feb 4, 2026
…PopSynth#744) * move config files * generate a BSEDict for rst files * generate bsedict during docs build * hide generated files * more robust path, allow conversion to direct python * make BSEDict available in plot directives * use generated BSEDict everywhere * adjust changelog for accuracy
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This fixes #736.
Basically, it just uses the cosmic-settings.json to make a tiny .rst file that just includes a BSEDict in an ipython directive that can be dropped into tutorials. It also does a similar thing for plotting directives, making it available as "default_BSEDict" in each.
Obviously tutorials can still write out custom ones if people want, but this should avoid some confusion when new stuff gets added.
I also got rid of In[XX] in tutorials where I needed to change things anyway, we don't need those and it avoids messing up the order.