add source code render documentation
#1319
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
- Modify the `table_renderer` function in `decks.py` - Add a new function `source_code_renderer` in `decks.py` - Add a markdown figure for the source code renderer in `decks.py` - Add a markdown figure for the table renderer in `decks.py` Signed-off-by: jason.lai <[email protected]>
3 tasks
pingsutw
reviewed
Dec 18, 2023
- Add import statement for `SourceCodeRenderer` from `flytekitplugins.deck.renderer` - Change the `disable_deck` parameter of the `source_code_renderer` task to `enable_deck` Signed-off-by: jason.lai <[email protected]>
pingsutw
reviewed
Dec 18, 2023
| @@ -236,6 +236,30 @@ def table_renderer() -> None: | |||
| ) | |||
|
|
|||
|
|
|||
| # %% [markdown] | |||
| # :::{figure} https://raw.githubusercontent.com/flyteorg/static-resources/main/flytesnacks/user_guide/flyte_decks_source_code_renderer.png | |||
There was a problem hiding this comment.
did you create a PR to static resources? I can't find it.
There was a problem hiding this comment.
sorry, I thought this image file would be generated automatically, right?
There was a problem hiding this comment.
it sounds like I need to manually create the file.
There was a problem hiding this comment.
updated
flyteorg/static-resources#33
pingsutw
approved these changes
Dec 19, 2023
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.
add
source coderender documentationtable_rendererfunction indecks.pysource_code_rendererindecks.pydecks.pydecks.pyAssociated PR: flyteorg/flytekit#2038