Make sure docs cache rebuilds + organise tutorials + document dt_mass_modifiers#792
Open
TomWagg wants to merge 9 commits into
Open
Make sure docs cache rebuilds + organise tutorials + document dt_mass_modifiers#792TomWagg wants to merge 9 commits into
dt_mass_modifiers#792TomWagg wants to merge 9 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #792 +/- ##
============================================
- Coverage 86.91% 76.31% -10.60%
============================================
Files 40 58 +18
Lines 25542 28097 +2555
Branches 0 919 +919
============================================
- Hits 22198 21440 -758
- Misses 3344 6353 +3009
- Partials 0 304 +304 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
dt_mass_modifiers
TomWagg
commented
May 31, 2026
|
|
||
| # General information about the project. | ||
| project = u'cosmic' | ||
| copyright = u'2021, Katie Breivik' |
Collaborator
Author
There was a problem hiding this comment.
@katiebreivik highlighting that I added my name to the bit that shows up at the bottom of each docs page (so that you can veto if you like, no worries either way! 🙂 )
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
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.
I got carried away and this PR is actually 3 things sorry 😅
Docs caching
@katiebreivik pointed out that rebuilding the docs was super slow. I tracked down a few issues and no rebuilds are super fast locally, only edited files are changed :)
Why it was slow is basically two reasons. 1) The thing where BSEDict is generated dynamically meant that every time it dynamically inserted it then the file was marked as changed and removed from the cache. Now I first make it check whether the settings have actually changed and, if not, leave it in the cache. 2) In interface.rst we were including image directives that were referencing files made at fixed times and that also messed up the cache. Now [at]savefig handles all that.
(...let's not discuss who wrote the four files that were causing the issues 😇 )
Tutorials organisation
I re-organised anything that was a tutorial into a clearer collection so it's easier to navigate. There's also a landing page at tutorials.rst that puts them all together neatly in a grid. Note this will change the URLs of these pages because they are in folders, but should only be an issue if someone has it hardcoded somewhere for some reason.
dt_mass_modifiersdocsI wrote up a docs page for
dt_mass_modifiersfinally so this will fix #758