docs: Add Python side by side examples to walkthrough #15095
Conversation
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
* Add Python code to hello-world walkthrough page to ensure everything works * Features added: * `pymdownx.blocks.tab` for tabbed examples * Deprecated `codehilite` replaced with `pymdownx.highlight`, which with `content.code.copy`, allows copying from code blocks * `content.code.annotate` for expandable code annotations * `content.tabs.link` to ensure that if users choose "Python", then all tabbed examples will change * `pymdownx.superfences` added by itself, as adding `custom_fences` means the defaults are not enabled Signed-off-by: Elliot Gunton <[email protected]>
* For the first few pages Signed-off-by: Elliot Gunton <[email protected]>
Signed-off-by: Elliot Gunton <[email protected]>
Signed-off-by: Elliot Gunton <[email protected]>
elliotgunton
changed the title
gianarb
approved these changes
Dec 3, 2025
Contributor
gianarb
left a comment
gianarb
left a comment
There was a problem hiding this comment.
In general, I really like documentations that are not tight to a specific language if they support more than one 👍
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.
Motivation
Argo Workflows focuses on using YAML to write Workflows. It is not immediately obvious from the Walkthrough that Python is usable through Hera. Using the tabbed approach for the code examples means users can view the entire walkthrough in their preferred language, which should be even more useful if/when Argo Workflows supports SDKs in other languages (notably Go could be used). The tab is "linked" throughout the docs, so once a reader clicks "Python", all tabbed examples will switch to Python.
Modifications
mkdocs.ymlconfiguration to allow features like the tabbed examplesScripts and Resultspage wording and introducing Hera for Python.containerwhich isn't the main strength of Hera).herapackage and link to the Hera walkthrough for a Python-centric walkthrough.The finished result looks like:
YAML:
Python:
Annotation:
