fix(docs): render Mermaid diagrams in docs #12464
Merged
Conversation
This file contains 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
- `docs/retries.md` has a Mermaid diagram that renders out-of-the-box on GH but not on the docs site itself - add a `pymdownx.superfences` config to render out Mermaid diagrams in `mkdocs` per https://squidfunk.github.io/mkdocs-material/reference/diagrams/#configuration follow-up to 310bb5a Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
agilgur5
added
area/docs
jmeridth
approved these changes
Jan 4, 2024
I think you mean responsive. Technically speaking, yes, it's a percentage of the screen:
That's a variant of responsive design (it used to be called adaptive design back in the day (~2014), but that now means something different). In full responsive design, you may want to render a different image for different screen sizes. GitHub has the fancy controls and mouse gestures that let you zoom and scroll the diagram which this does not. Those are nice, but I think this is good enough. Users can click the image to see it full screen if they want to and then zoom from there etc |
|
Great thanks! Yes I meant responsive. |
terrytangyuan
approved these changes
Jan 4, 2024
|
Rendering properly on RTD now 🙂 : https://argo-workflows.readthedocs.io/en/latest/retries/#retry-policies |
jmeridth
added a commit
to jmeridth/argo-workflows
that referenced
this pull request
Jan 5, 2024
Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5 Includes files list from argoproj#12414 description Signed-off-by: jmeridth <jmeridth@gmail.com> Co-authored-by: Anton Gilgur <agilgur5@gmail.com>
jmeridth
added a commit
to jmeridth/argo-workflows
that referenced
this pull request
Jan 5, 2024
Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5 Includes files list from argoproj#12414 description Signed-off-by: jmeridth <jmeridth@gmail.com> Co-authored-by: Anton Gilgur <agilgur5@gmail.com>
jmeridth
added a commit
to jmeridth/argo-workflows
that referenced
this pull request
Jan 5, 2024
Includes fixes from argoproj#12464, argoproj#12466, argoproj#12465 - all authored by @agilgur5 Includes files list from argoproj#12414 description Signed-off-by: jmeridth <jmeridth@gmail.com> Co-authored-by: Anton Gilgur <agilgur5@gmail.com>
7 tasks
isubasinghe
pushed a commit
to isubasinghe/argo-workflows
that referenced
this pull request
Feb 27, 2024
isubasinghe
pushed a commit
to isubasinghe/argo-workflows
that referenced
this pull request
Feb 27, 2024
isubasinghe
pushed a commit
to isubasinghe/argo-workflows
that referenced
this pull request
Feb 27, 2024
isubasinghe
pushed a commit
to isubasinghe/argo-workflows
that referenced
this pull request
Feb 28, 2024
Signed-off-by: Isitha Subasinghe <isubasinghe@student.unimelb.edu.au>
isubasinghe
pushed a commit
to isubasinghe/argo-workflows
that referenced
this pull request
Mar 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation
docs/retries.mdhas a Mermaid diagram that renders out-of-the-box on GH but not on the docs site itselfmkdocsfollow-up to #11005, #11390 (comment), and Nov 21st Contributor Meeting
Modifications
pymdownx.superfencesconfig to render out Mermaid diagrams inmkdocsper https://squidfunk.github.io/mkdocs-material/reference/diagrams/#configurationVerification
Ran
make docsfollowed byopen site/retries/index.htmlto view in the browser.Screenshots:
Before:
After:
