Skip to content

Multiple doc improvements#318

Merged
ablaom merged 15 commits intodevfrom
dump-rdatasets-in-docs
Dec 27, 2025
Merged

Multiple doc improvements#318
ablaom merged 15 commits intodevfrom
dump-rdatasets-in-docs

Conversation

@ablaom
Copy link
Collaborator

@ablaom ablaom commented Dec 22, 2025

Replaces #316. Closes #314.

This PR is chiefly about making doc generation more robust across all the examples. There are only small content tweaks.

This PR:

  • Replaces all RNGs in examples with a manually seeded StableRNG to enforce reproducibility across Julia versions. (Some instability around RNG's caused the docs to crash after Julia 1.12 release).
  • Dump RDatasets as a doc dependency, by using MLJ's built-in iris dataset. (Current version of RDatasets blocks using latest versions of MLJ)
  • Remove the Project.toml/Manifest.toml files in each example folder, as these are not actually being used to generate the docs. Rather the /docs environment is used. Each example folder has README.md which now points users to that /docs environment.

@codecov
Copy link

codecov bot commented Dec 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.85%. Comparing base (108508e) to head (afb983e).
⚠️ Report is 18 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev     #318      +/-   ##
==========================================
+ Coverage   92.67%   94.85%   +2.17%     
==========================================
  Files          14       15       +1     
  Lines         519      525       +6     
==========================================
+ Hits          481      498      +17     
+ Misses         38       27      -11     

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@EssamWisam
Copy link
Collaborator

EssamWisam commented Dec 23, 2025

Looks great to me. I remember experiencing confusion with the project.tomls. Thank you so much for this, I took a look and all looks good to me.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is removing this intended?

Copy link
Collaborator Author

@ablaom ablaom Dec 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, in two cases I have intentionally removed the pre-executed versions of the notebooks. Literate.jl successfully creates executables for the others but fails on these (and this was true in the past for me). Previously, I would just execute by loading into jupyter but, as is typical in my experience of using Jupyter notebooks with Julia, there's some voodoo magic I have to figure out to get the latest julia kernel to load properly and I decided to give up this time around, because I don't like to maintain fragile workflows like this.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here also we have the unexecuted notebook only. I don't mind not having the other one though in both instances.

@ablaom
Copy link
Collaborator Author

ablaom commented Dec 27, 2025

Thank you @EssamWisam for the review!

@ablaom ablaom merged commit 2d2463c into dev Dec 27, 2025
8 checks passed
@ablaom ablaom deleted the dump-rdatasets-in-docs branch December 27, 2025 05:46
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.

2 participants