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

Add example notebooks to docs #37

Merged
merged 15 commits into from
Jan 15, 2024
Merged

Add example notebooks to docs #37

merged 15 commits into from
Jan 15, 2024

Conversation

liamhuber
Copy link
Member

For rendering on readthedocs

Copy link

Binder 👈 Launch a binder notebook on branch pyiron/pyiron_ontology/docs_notebooks

Copy link

codacy-production bot commented Jan 12, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (96afa88) 459 418 91.07%
Head commit (0ba5375) 459 (+0) 418 (+0) 91.07% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#37) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

You may notice some variations in coverage metrics with the latest Coverage engine update. For more details, visit the documentation

@liamhuber
Copy link
Member Author

They render OK, but sphinx parses each notebook heading as a full heading; I'd like to move them each to their own level so that notebook sub-headings get parsed sensibly. Alternatively maybe a thumbnail gallery is the way to go

@liamhuber
Copy link
Member Author

I like the gallery much better, but am having trouble getting the default thumbnail to register

@liamhuber
Copy link
Member Author

Good enough. Just need to be able to see it on the white background now.

@liamhuber liamhuber merged commit 9f51a6f into myst_docs Jan 15, 2024
1 of 2 checks passed
@liamhuber liamhuber deleted the docs_notebooks branch January 15, 2024 20:44
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