📚 Fix sizing classes, grid rows, tab links, MyST prereqs#273
Merged
Conversation
chrisjsewell
force-pushed
the
brief/08-docs-quick-fixes
branch
from
0f0d22e to
2928caf
Compare
- Correct the sizing CSS class names to the generated
`sd-w-{25,50,75,100,auto}` / `sd-h-{25,50,75,100,auto}`
(per `style/_sizing.scss`) (#172)
- Note the MyST syntax extensions (`colon_fence`, `html_image`,
`attrs_inline`) that the documentation examples rely on (#122)
- Add a "Multiple rows" section to the grid docs, and clarify that a
single-value column count is fixed across all screen sizes, for both
the `grid` argument and the item-level `columns` option (#184, #182)
- Document how to author links to synchronised tabs with query strings,
from both MyST Markdown and reStructuredText (#247)
chrisjsewell
force-pushed
the
brief/08-docs-quick-fixes
branch
from
2928caf to
39180ba
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #273 +/- ##
=======================================
Coverage 88.08% 88.08%
=======================================
Files 11 11
Lines 1041 1041
=======================================
Hits 917 917
Misses 124 124
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
2 participants
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.
Documentation quick fixes. Closes #172, closes #122, closes #184, closes #247.
css_classes.mdsizing section now lists the classes that actually exist (sd-w-*/sd-h-*, verified against_sizing.scss) instead of the nonexistentsd-width-*/sd-height-*.get_started.mdgains a note listing the MyST extensions the shipped examples rely on (colon_fence,html_image,attrs_inline), each verified by grepping the docs, with a link to the myst-parser docs.:columns:prevents grid from re-arranging items #182):grids.mdgains a "Multiple rows" section (auto-wrapping vs deliberate second grid) and now states explicitly that a single-value grid argument fixes columns across all breakpoints while the four-value form is responsive — likewise for per-item:columns:.tabs.mdgains "Linking to synchronised tabs" with working MyST and rST examples; the MyST recipe uses{.external}(attrs_inline) because a plain[text](page.html?query)link becomes an unresolvablepending_xref(verified against myst-parser 5.1 link rendering), plus the output-relative-URL caveat.Validation:
tox -e docs-furoanddocs-pydataclean (-nW),tox -e py311untouched-green; rendered HTML spot-checked (literal query-string href emitted).