From e4a9facc3f9128c7989b728a31bb2129940b20ea Mon Sep 17 00:00:00 2001 From: Niels Bantilan Date: Mon, 5 Feb 2024 11:35:44 -0500 Subject: [PATCH] update conf.py, kernelspec config Signed-off-by: Niels Bantilan --- docs/conf.py | 6 +++++- docs/introduction/core_use_cases/analytics.md | 7 +++++++ docs/introduction/core_use_cases/data_engineering.md | 7 +++++++ docs/introduction/core_use_cases/machine_learning.md | 7 +++++++ docs/introduction/flyte_fundamentals/extending_flyte.md | 7 +++++++ docs/introduction/flyte_fundamentals/optimizing_tasks.md | 7 +++++++ docs/introduction/flyte_fundamentals/run_schedule.md | 7 +++++++ .../introduction/flyte_fundamentals/tasks_and_workflows.md | 7 +++++++ .../visualizing_task_input_and_output.md | 7 +++++++ 9 files changed, 61 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 24f747aa4d..136cb173fa 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -94,7 +94,7 @@ autosummary_generate = True -suppress_warnings = ["autosectionlabel.*"] +suppress_warnings = ["autosectionlabel.*", "myst.header"] autodoc_typehints = "description" # The master toctree document. @@ -294,6 +294,9 @@ "flytesnacks/**/*", "examples/**/*", ] +nb_custom_formats = { + ".md": ["jupytext.reads", {"fmt": "md:myst"}], +} # Pattern for removing intersphinx references from source files. # This should handle cases like: @@ -447,6 +450,7 @@ def filter(self, record: logging.LogRecord) -> bool: "Definition list ends without a blank line", "autodoc: failed to import module 'awssagemaker' from module 'flytekitplugins'", "Enumerated list ends without a blank line", + 'Unknown directive type "toc".', # need to fix flytesnacks/contribute.md ) if msg.strip().startswith(filter_out): diff --git a/docs/introduction/core_use_cases/analytics.md b/docs/introduction/core_use_cases/analytics.md index fff901128e..06e2efdcaa 100644 --- a/docs/introduction/core_use_cases/analytics.md +++ b/docs/introduction/core_use_cases/analytics.md @@ -1,3 +1,10 @@ +--- +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + (getting_started_analytics)= # Analytics diff --git a/docs/introduction/core_use_cases/data_engineering.md b/docs/introduction/core_use_cases/data_engineering.md index 1131da204f..941dbdbcdf 100644 --- a/docs/introduction/core_use_cases/data_engineering.md +++ b/docs/introduction/core_use_cases/data_engineering.md @@ -1,3 +1,10 @@ +--- +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + (getting_started_data_engineering)= # Data Engineering diff --git a/docs/introduction/core_use_cases/machine_learning.md b/docs/introduction/core_use_cases/machine_learning.md index 307eb0fec1..04c573e1b3 100644 --- a/docs/introduction/core_use_cases/machine_learning.md +++ b/docs/introduction/core_use_cases/machine_learning.md @@ -1,3 +1,10 @@ +--- +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + (getting_started_machine_learning)= # Machine Learning diff --git a/docs/introduction/flyte_fundamentals/extending_flyte.md b/docs/introduction/flyte_fundamentals/extending_flyte.md index a0fde0dc56..db4eabe14b 100644 --- a/docs/introduction/flyte_fundamentals/extending_flyte.md +++ b/docs/introduction/flyte_fundamentals/extending_flyte.md @@ -1,3 +1,10 @@ +--- +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + (getting_started_extending_flyte)= # Extending Flyte diff --git a/docs/introduction/flyte_fundamentals/optimizing_tasks.md b/docs/introduction/flyte_fundamentals/optimizing_tasks.md index 421bf6269a..0f8057dc55 100644 --- a/docs/introduction/flyte_fundamentals/optimizing_tasks.md +++ b/docs/introduction/flyte_fundamentals/optimizing_tasks.md @@ -1,3 +1,10 @@ +--- +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + (getting_started_optimizing_tasks)= # Optimizing Tasks diff --git a/docs/introduction/flyte_fundamentals/run_schedule.md b/docs/introduction/flyte_fundamentals/run_schedule.md index 816e607a89..e4a1f98470 100644 --- a/docs/introduction/flyte_fundamentals/run_schedule.md +++ b/docs/introduction/flyte_fundamentals/run_schedule.md @@ -1,3 +1,10 @@ +--- +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + (getting_started_run_and_schedule)= # Running and Scheduling Workflows diff --git a/docs/introduction/flyte_fundamentals/tasks_and_workflows.md b/docs/introduction/flyte_fundamentals/tasks_and_workflows.md index b97b315f22..fb16e85959 100644 --- a/docs/introduction/flyte_fundamentals/tasks_and_workflows.md +++ b/docs/introduction/flyte_fundamentals/tasks_and_workflows.md @@ -1,3 +1,10 @@ +--- +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + (getting_started_tasks_and_workflows)= # Tasks, Workflows and LaunchPlans diff --git a/docs/introduction/flyte_fundamentals/visualizing_task_input_and_output.md b/docs/introduction/flyte_fundamentals/visualizing_task_input_and_output.md index 32bb76ec88..928a0cd2bc 100644 --- a/docs/introduction/flyte_fundamentals/visualizing_task_input_and_output.md +++ b/docs/introduction/flyte_fundamentals/visualizing_task_input_and_output.md @@ -1,3 +1,10 @@ +--- +kernelspec: + display_name: Python 3 + language: python + name: python3 +--- + (getting_started_visualizing_task_input_and_output)= # Visualizing task input and output