Repository navigation
Expand documentation and Mermaid examples - #5
Merged
Merged
Conversation
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5 +/- ##
=======================================
Coverage 93.77% 93.77%
=======================================
Files 2 2
Lines 241 241
Branches 37 37
=======================================
Hits 226 226
Misses 8 8
Partials 7 7 ☔ 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
1 participant
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.
Description
Add a first-diagram tutorial, task guides for styling, migration, troubleshooting, and local development, and an explanation of browser rendering and non-HTML output. Organize navigation by Diátaxis mode and expand the configuration reference.
Expand the gallery to 16 diagrams with source listings read from the same files as the rendered examples. Add four rendered reStructuredText examples for captions, references, accessibility, zoom, code blocks, and the Pele alias. Move the documentation homepage to
/index.htmland document installation from the repository while the implementation is unreleased on PyPI.Verified 23 Python tests, four Chromium tests covering all 20 rendered examples, warning-free HTML and text builds, all three tutorial stages after a fresh source installation, lint/type checks, and wheel/sdist checks.
Type of Change
Checklist
make lint)make test)