update dir structure to autogenerated examples (flyteorg#200)

Signed-off-by: cosmicBboy <[email protected]>

.gitignore

@@ -17,8 +17,6 @@ _build/
 .vim/
 ._rsts/
 *.zip
-auto_*/
-docs/_rsts/
 .sandbox/bin/
 .sandbox/data/
 .vscode/

cookbook/.gitignore

@@ -9,4 +9,5 @@ release-snacks/*.tgz
 ._rsts/
 *.zip
 auto_*/
+docs/auto/*
 docs/_rsts/

cookbook/docs/Makefile

@@ -10,3 +10,4 @@ html:
 clean:
 	rm -rf _build
 	rm -rf auto_*
+	rm -rf auto/*

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

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',)

cookbook/docs/deployment.rst

@@ -6,6 +6,6 @@ Deployment
     :maxdepth: -1
     :caption: Deployment
 
-    Workflow Deployment <auto_deployment_workflow/index>
-    Cluster Deployment <auto_deployment_cluster/index>
-    Deployment Guides <auto_deployment_guides/index>
+    Workflow Deployment <auto/deployment/workflow/index>
+    Cluster Deployment <auto/deployment/cluster/index>
+    Deployment Guides <auto/deployment/guides/index>

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.

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

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

cookbook/docs/index.rst

@@ -29,13 +29,13 @@ the `getting started <https://docs.flyte.org/en/latest/getting_started.html>`__
    :hidden:
 
    Introduction <self>
-   Flyte Basics <auto_core_flyte_basics/index>
-   Control Flow <auto_core_control_flow/index>
-   Type System <auto_type_system/index>
-   Testing <auto_testing/index>
-   Containerization <auto_core_containerization/index>
+   Flyte Basics <auto/core/flyte_basics/index>
+   Control Flow <auto/core/control_flow/index>
+   Type System <auto/type_system/index>
+   Testing <auto/testing/index>
+   Containerization <auto/core/containerization/index>
    deployment
-   Control Plane <auto_control_plane/index>
+   Control Plane <auto/control_plane/index>
    integrations 
    Extending flyte <extending_flyte>
 

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

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

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