Skip to content

Improvements to docs rendering for models and datablocks #1200

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

Merged
merged 5 commits into from
May 19, 2025

Conversation

ml-evs
Copy link
Member

@ml-evs ml-evs commented May 19, 2025

Improves docs formatting and removes now-defunct notes, also updates to the latest mkdocs/mkdocs-materials/mkdocstrings, which should have better pydantic support going forward.

@ml-evs ml-evs added the documentation Improvements or additions to documentation label May 19, 2025
Copy link

codecov bot commented May 19, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.20%. Comparing base (3485da7) to head (240fb91).
⚠️ Report is 85 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1200      +/-   ##
==========================================
+ Coverage   70.90%   71.20%   +0.29%     
==========================================
  Files          64       65       +1     
  Lines        4276     4320      +44     
==========================================
+ Hits         3032     3076      +44     
  Misses       1244     1244              
Files with missing lines Coverage Δ
pydatalab/src/pydatalab/apps/chat/__init__.py 100.00% <100.00%> (ø)
pydatalab/src/pydatalab/apps/chat/blocks.py 20.16% <100.00%> (ø)
pydatalab/src/pydatalab/models/cells.py 91.37% <100.00%> (+0.81%) ⬆️
pydatalab/src/pydatalab/models/files.py 100.00% <100.00%> (ø)
pydatalab/src/pydatalab/models/relationships.py 94.44% <100.00%> (+1.11%) ⬆️
...datalab/src/pydatalab/models/starting_materials.py 100.00% <100.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ml-evs ml-evs force-pushed the ml-evs/docs-updates branch from 34ac08f to 205848d Compare May 19, 2025 16:15
@ml-evs ml-evs changed the title Docs improvements Improvements to docs rendering for models and datablocks May 19, 2025
Copy link

cypress bot commented May 19, 2025

datalab    Run #3352

Run Properties:  status check passed Passed #3352  •  git commit 322a662393 ℹ️: Merge 240fb91ab826b53fa3edb74342e37b8be3d11c7f into 3485da7ba4eb00ab6ee35bc3d259...
Project datalab
Branch Review ml-evs/docs-updates
Run status status check passed Passed #3352
Run duration 09m 19s
Commit git commit 322a662393 ℹ️: Merge 240fb91ab826b53fa3edb74342e37b8be3d11c7f into 3485da7ba4eb00ab6ee35bc3d259...
Committer Matthew Evans
View all properties for this run ↗︎

Test results
Tests that failed  Failures 0
Tests that were flaky  Flaky 0
Tests that did not run due to a developer annotating a test with .skip  Pending 0
Tests that did not run due to a failure in a mocha hook  Skipped 0
Tests that passed  Passing 504
View all changes introduced in this branch ↗︎

@ml-evs ml-evs force-pushed the ml-evs/docs-updates branch from 5b882dd to 240fb91 Compare May 19, 2025 16:32
@ml-evs
Copy link
Member Author

ml-evs commented May 19, 2025

Example before:

image

And after:

image

@ml-evs ml-evs merged commit a6f25a2 into main May 19, 2025
17 checks passed
@ml-evs ml-evs deleted the ml-evs/docs-updates branch May 19, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant