From 4d97acf424a6ea3a0f13de64b52b3248bc28759b Mon Sep 17 00:00:00 2001 From: Niels Bantilan Date: Fri, 7 May 2021 16:37:37 -0400 Subject: [PATCH] update dir structure to autogenerated examples (#200) Signed-off-by: cosmicBboy --- .gitignore | 2 - cookbook/.gitignore | 1 + cookbook/docs/Makefile | 1 + cookbook/docs/aws.rst | 6 +-- cookbook/docs/conf.py | 61 ++++++++++++++++------------- cookbook/docs/deployment.rst | 6 +-- cookbook/docs/extending_flyte.rst | 4 +- cookbook/docs/external_services.rst | 6 +-- cookbook/docs/flytekit_plugins.rst | 8 ++-- cookbook/docs/index.rst | 12 +++--- cookbook/docs/kubeflow.rst | 4 +- cookbook/docs/kubernetes.rst | 4 +- cookbook/docs/ml_training.rst | 4 +- 13 files changed, 63 insertions(+), 56 deletions(-) diff --git a/.gitignore b/.gitignore index 0d5f99f2a6..c81b63e1d6 100644 --- a/.gitignore +++ b/.gitignore @@ -17,8 +17,6 @@ _build/ .vim/ ._rsts/ *.zip -auto_*/ -docs/_rsts/ .sandbox/bin/ .sandbox/data/ .vscode/ diff --git a/cookbook/.gitignore b/cookbook/.gitignore index 75a0e5f800..5f8c34e347 100644 --- a/cookbook/.gitignore +++ b/cookbook/.gitignore @@ -9,4 +9,5 @@ release-snacks/*.tgz ._rsts/ *.zip auto_*/ +docs/auto/* docs/_rsts/ diff --git a/cookbook/docs/Makefile b/cookbook/docs/Makefile index aa2c37eb09..c99da11cde 100644 --- a/cookbook/docs/Makefile +++ b/cookbook/docs/Makefile @@ -10,3 +10,4 @@ html: clean: rm -rf _build rm -rf auto_* + rm -rf auto/* diff --git a/cookbook/docs/aws.rst b/cookbook/docs/aws.rst index dfe8687302..95be23ab26 100644 --- a/cookbook/docs/aws.rst +++ b/cookbook/docs/aws.rst @@ -6,6 +6,6 @@ AWS :maxdepth: -1 :caption: Contents - auto_integrations_aws_athena/index - auto_integrations_aws_sagemaker_training/index - auto_integrations_aws_sagemaker_pytorch/index + auto/integrations/aws/athena/index + auto/integrations/aws/sagemaker_training/index + auto/integrations/aws/sagemaker_pytorch/index diff --git a/cookbook/docs/conf.py b/cookbook/docs/conf.py index 283b960143..f2988206d6 100644 --- a/cookbook/docs/conf.py +++ b/cookbook/docs/conf.py @@ -185,6 +185,13 @@ def __call__(self, filename): "color-brand-primary": "#9D68E4", "color-brand-content": "#9D68E4", }, + # custom flyteorg furo theme options + "github_repo": "flytesnacks", + "github_username": "flyteorg", + "github_commit": "master", + "docs_path": "cookbook/docs", # path to documentation source + "sphinx_gallery_src_dir": "cookbook", # path to directory of sphinx gallery source files relative to repo root + "sphinx_gallery_dest_dir": "auto", # path to root directory containing auto-generated sphinx gallery examples } # Add any paths that contain custom static files (such as style sheets) here, @@ -224,33 +231,33 @@ def __call__(self, filename): "../core/extend_flyte", ] gallery_dirs = [ - "auto_core_flyte_basics", - "auto_core_control_flow", - "auto_type_system", - "auto_case_studies_ml_training_pima_diabetes", - "auto_case_studies_ml_training_house_price_prediction", - "auto_testing", - "auto_core_containerization", - "auto_deployment_workflow", - "auto_deployment_cluster", - "auto_deployment_guides", - "auto_control_plane", - "auto_integrations_flytekit_plugins_sqllite3", - "auto_integrations_flytekit_plugins_papermilltasks", - "auto_integrations_flytekit_plugins_sqlalchemy", - "auto_integrations_flytekit_plugins_pandera", - "auto_integrations_kubernetes_pod", - "auto_integrations_kubernetes_k8s_spark", - "auto_integrations_kubernetes_kftensorflow", - "auto_integrations_kubernetes_kfpytorch", - "auto_integrations_aws_athena", - "auto_integrations_aws_sagemaker_training", - "auto_integrations_aws_sagemaker_pytorch", - "auto_integrations_gcp", - "auto_integrations_external_services_hive", - "auto_integrations_external_services_databricks", - "auto_integrations_external_services_snowflake", - "auto_core_extend_flyte", + "auto/core/flyte_basics", + "auto/core/control_flow", + "auto/type_system", + "auto/case_studies/ml_training/pima_diabetes", + "auto/case_studies/ml_training/house_price_prediction", + "auto/testing", + "auto/core/containerization", + "auto/deployment/workflow", + "auto/deployment/cluster", + "auto/deployment/guides", + "auto/control_plane", + "auto/integrations/flytekit_plugins/sqllite3", + "auto/integrations/flytekit_plugins/papermilltasks", + "auto/integrations/flytekit_plugins/sqlalchemy", + "auto/integrations/flytekit_plugins/pandera", + "auto/integrations/kubernetes/pod", + "auto/integrations/kubernetes/k8s_spark", + "auto/integrations/kubernetes/kftensorflow", + "auto/integrations/kubernetes/kfpytorch", + "auto/integrations/aws/athena", + "auto/integrations/aws/sagemaker_training", + "auto/integrations/aws/sagemaker_pytorch", + "auto/integrations/gcp", + "auto/integrations/external_services/hive", + "auto/integrations/external_services/databricks", + "auto/integrations/external_services/snowflake", + "auto/core/extend_flyte", ] # image_scrapers = ('matplotlib',) diff --git a/cookbook/docs/deployment.rst b/cookbook/docs/deployment.rst index 17ae9c6b68..d02c3a459d 100644 --- a/cookbook/docs/deployment.rst +++ b/cookbook/docs/deployment.rst @@ -6,6 +6,6 @@ Deployment :maxdepth: -1 :caption: Deployment - Workflow Deployment - Cluster Deployment - Deployment Guides + Workflow Deployment + Cluster Deployment + Deployment Guides diff --git a/cookbook/docs/extending_flyte.rst b/cookbook/docs/extending_flyte.rst index 6a5524a53c..25f924875d 100644 --- a/cookbook/docs/extending_flyte.rst +++ b/cookbook/docs/extending_flyte.rst @@ -10,8 +10,8 @@ When & How to Extend Flyte :hidden: extend_flyte_introduction - auto_core_extend_flyte/custom_task_plugin - auto_core_extend_flyte/run_custom_types + auto/core/extend_flyte/custom_task_plugin + auto/core/extend_flyte/run_custom_types extend_flyte_backend_plugins .. NOTE:: These docs are still work in progress. Please read through and if you have any questions don't shy away from either filing a github issue or ping us in the Slack channel. The community loves plugins and would love to help you in any way. diff --git a/cookbook/docs/external_services.rst b/cookbook/docs/external_services.rst index 2e6367fba3..456f618dd0 100644 --- a/cookbook/docs/external_services.rst +++ b/cookbook/docs/external_services.rst @@ -6,6 +6,6 @@ External Services :maxdepth: -1 :caption: Contents - auto_integrations_external_services_hive/index - auto_integrations_external_services_databricks/index - auto_integrations_external_services_snowflake/index + auto/integrations/external_services/hive/index + auto/integrations/external_services/databricks/index + auto/integrations/external_services/snowflake/index diff --git a/cookbook/docs/flytekit_plugins.rst b/cookbook/docs/flytekit_plugins.rst index 1deb976f83..c86acf64d3 100644 --- a/cookbook/docs/flytekit_plugins.rst +++ b/cookbook/docs/flytekit_plugins.rst @@ -7,7 +7,7 @@ Flytekit Plugins :maxdepth: -1 :caption: Contents - auto_integrations_flytekit_plugins_sqllite3/index - auto_integrations_flytekit_plugins_sqlalchemy/index - auto_integrations_flytekit_plugins_papermilltasks/index - auto_integrations_flytekit_plugins_pandera/index + auto/integrations/flytekit_plugins/sqllite3/index + auto/integrations/flytekit_plugins/sqlalchemy/index + auto/integrations/flytekit_plugins/papermilltasks/index + auto/integrations/flytekit_plugins/pandera/index diff --git a/cookbook/docs/index.rst b/cookbook/docs/index.rst index 444adf75fa..2dce27bf06 100644 --- a/cookbook/docs/index.rst +++ b/cookbook/docs/index.rst @@ -29,13 +29,13 @@ the `getting started `__ :hidden: Introduction - Flyte Basics - Control Flow - Type System - Testing - Containerization + Flyte Basics + Control Flow + Type System + Testing + Containerization deployment - Control Plane + Control Plane integrations Extending flyte diff --git a/cookbook/docs/kubeflow.rst b/cookbook/docs/kubeflow.rst index c4d1740df2..0e8f72c09f 100644 --- a/cookbook/docs/kubeflow.rst +++ b/cookbook/docs/kubeflow.rst @@ -6,5 +6,5 @@ Kubeflow :maxdepth: 1 :caption: Contents - auto_integrations_kubernetes_kftensorflow/index - auto_integrations_kubernetes_kfpytorch/index + auto/integrations/kubernetes/kftensorflow/index + auto/integrations/kubernetes/kfpytorch/index diff --git a/cookbook/docs/kubernetes.rst b/cookbook/docs/kubernetes.rst index af98f6b85c..9723981124 100644 --- a/cookbook/docs/kubernetes.rst +++ b/cookbook/docs/kubernetes.rst @@ -6,6 +6,6 @@ Kubernetes :maxdepth: -1 :caption: Contents - auto_integrations_kubernetes_pod/index - auto_integrations_kubernetes_k8s_spark/index + auto/integrations/kubernetes/pod/index + auto/integrations/kubernetes/k8s_spark/index kubeflow diff --git a/cookbook/docs/ml_training.rst b/cookbook/docs/ml_training.rst index a0f1f1e032..1b85afa1b2 100644 --- a/cookbook/docs/ml_training.rst +++ b/cookbook/docs/ml_training.rst @@ -6,5 +6,5 @@ ML Training :maxdepth: -1 :caption: Contents - auto_case_studies_ml_training_pima_diabetes/index - auto_case_studies_ml_training_house_price_prediction/index + auto/case_studies/ml_training/pima_diabetes/index + auto/case_studies/ml_training/house_price_prediction/index