[WIP] [Docs] Add usage for jupyter notebook interactive mode

[Mecoli1219]

Tracking issue

#5907

Screenshots

Check all the applicable boxes

• I updated the documentation accordingly.
• All new and existing tests passed.
• All commits are signed-off.

Related PRs

Important Note: We should revert the change of import_project in conf.py after this PR (flytesnacks#1754) is merged!

Docs link

https://flyte--5997.org.readthedocs.build/en/5997/user_guide/flyte_fundamentals/running_and_scheduling_workflows.html

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.03%. Comparing base (b3330ba) to head (2a420f7).
Report is 17 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #5997      +/-   ##
==========================================
- Coverage   37.03%   37.03%   -0.01%     
==========================================
  Files        1313     1313              
  Lines      131618   131622       +4     
==========================================
- Hits        48745    48743       -2     
- Misses      78645    78651       +6     
  Partials     4228     4228              

Flag	Coverage Δ
unittests-datacatalog	51.58% <ø> (ø)
unittests-flyteadmin	54.07% <ø> (-0.03%)	⬇️
unittests-flytecopilot	22.23% <ø> (ø)
unittests-flytectl	62.46% <ø> (ø)
unittests-flyteidl	7.25% <ø> (ø)
unittests-flyteplugins	53.68% <ø> (+0.01%)	⬆️
unittests-flytepropeller	43.11% <ø> (ø)
unittests-flytestdlib	55.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[Mecoli1219]

@samhita-alla @davidmirror-ops How does this look? (I am using a hacky way now. I'm unsure if there is any other appropriate method to render a cell from Jupyter Notebook.)

[Future-Outlier]

Michael, you are 絕活哥

[samhita-alla]

@Mecoli1219 thanks so much for working on this! have you tried using https://docs.readthedocs.io/en/stable/guides/jupyter.html#using-notebooks-in-other-formats since myst-nb is already enabled as a sphinx extension?

[Mecoli1219]

@samhita-alla I realize the link you provided renders the entire jupytext format file as a single sphinx page. What I'm specifically looking for is rendering just one cell from an ipynb file, ideally with a link to the flytesnacks example. (Previously this worked with rli/remoteliteralinclude, but since we've switched to literalinclude, we lost the linking capability).

Thinking about it now, I may be overcomplicating this. We could simply write similar example code directly in our docs like in my screenshot.

What are your thoughts on the interactive_mode documentation - should we include the complete example, or would it be better to just show the basic usage (like in my screenshot) and perhaps provide links to flytesnacks for more detailed examples?

[davidmirror-ops]

@Mecoli1219 I'd vote for rendering the notebook as a page if that's simpler. The benefit is that the notebook in flytesnacks would be "self contained" with code and instructions in a single place.

[Mecoli1219]

Closed as the alternative PR is created: #6036