Re-organize page components for jobs docs.

qiuosier · qiuosier · commit aad957e6e5e7 · 2023-02-23T10:53:39.000-05:00
diff --git a/docs/source/user_guide/jobs/_template/runtime_types.rst b/docs/source/user_guide/jobs/_template/runtime_types.rst
diff --git a/docs/source/user_guide/jobs/components/overview.rst b/docs/source/user_guide/jobs/components/overview.rst
diff --git a/docs/source/user_guide/jobs/components/runtime_non_byoc.rst b/docs/source/user_guide/jobs/components/runtime_non_byoc.rst
@@ -0,0 +1,11 @@
+* :py:class:`~ads.jobs.PythonRuntime`
+  for Python code stored locally, OCI object storage, or other remote location supported by
+  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_. See :doc:`run_python`.
+* :py:class:`~ads.jobs.GitPythonRuntime`
+  for Python code from a Git repository. See :doc:`run_git`.
+* :py:class:`~ads.jobs.NotebookRuntime`
+  for a single Jupyter notebook stored locally, OCI object storage, or other remote location supported by
+  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_. See :doc:`run_notebook`.
+* :py:class:`~ads.jobs.ScriptRuntime`
+  for bash or shell scripts stored locally, OCI object storage, or other remote location supported by
+  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_. See :doc:`run_script`.
diff --git a/docs/source/user_guide/jobs/components/runtime_types.rst b/docs/source/user_guide/jobs/components/runtime_types.rst
@@ -0,0 +1,2 @@
+.. include:: ../jobs/components/runtime_non_byoc.rst
+* :py:class:`~ads.jobs.ContainerRuntime` for container images.
diff --git a/docs/source/user_guide/jobs/components/toc_local.rst b/docs/source/user_guide/jobs/components/toc_local.rst
@@ -0,0 +1,4 @@
+.. contents:: In this Page
+  :depth: 2
+  :local:
+  :backlinks: none
diff --git a/docs/source/user_guide/jobs/index.rst b/docs/source/user_guide/jobs/index.rst
@@ -1,9 +1,7 @@
-.. _jobs-1:
-
 #################
 Data Science Jobs
 #################
 
-.. include:: ../jobs/overview.rst
+.. include:: ../jobs/components/overview.rst
 
 .. include:: ../jobs/toc.rst
diff --git a/docs/source/user_guide/jobs/infrastructure.rst b/docs/source/user_guide/jobs/infrastructure.rst
@@ -4,7 +4,6 @@ Infrastructure
 The Data Science Job infrastructure is defined by a :py:class:`~ads.jobs.DataScienceJob` instance.
 For example:
 
-
 .. code-block:: python3
 
     from ads.jobs import DataScienceJob
diff --git a/docs/source/user_guide/jobs/runtime.rst b/docs/source/user_guide/jobs/runtime.rst
@@ -4,25 +4,17 @@ Runtime
 The *runtime* of a job defines the source code of your workload, environment variables, CLI arguments
 and other configurations for the environment to run the workload.
 
+.. include:: ../jobs/components/toc_local.rst
+
 Depending on the source code, ADS provides different types of *runtime* for defining a data science job,
 including:
 
-* :py:class:`~ads.jobs.PythonRuntime`
-  for Python code stored locally, OCI object storage, or other remote location supported by
-  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_
-* :py:class:`~ads.jobs.GitPythonRuntime`
-  for Python code from a Git repository.
-* :py:class:`~ads.jobs.NotebookRuntime`
-  for a single Jupyter notebook stored locally, OCI object storage, or other remote location supported by
-  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_
-* :py:class:`~ads.jobs.ScriptRuntime`
-  for bash or shell scripts stored locally, OCI object storage, or other remote location supported by
-  `fsspec <https://filesystem-spec.readthedocs.io/en/latest/>`_
-* :py:class:`~ads.jobs.ContainerRuntime` for container images.
+.. include:: ../jobs/components/runtime_types.rst
 
 
 Environment Variables
 =====================
+
 You can set environment variables for a runtime by calling
 :py:meth:`~ads.jobs.PythonRuntime.with_environment_variable()`.
 Environment variables enclosed by ``${...}`` will be substituted. For example:
@@ -159,8 +151,8 @@ For more details on custom conda environment, see
 <https://docs.oracle.com/en-us/iaas/data-science/using/conda_publishs_object.htm>`__.
 
 
-Override Configuration
-======================
+Override Configurations
+=======================
 
 When you call :py:meth:`ads.jobs.Job.run`, a new job run will be started with the configuration defined in the **job**.
 You may want to override the configuration with custom variables. For example,
diff --git a/docs/source/user_guide/model_training/training_with_oci.rst b/docs/source/user_guide/model_training/training_with_oci.rst
@@ -2,6 +2,6 @@
 Training with OCI
 #################
 
-.. include:: ../jobs/overview.rst
+.. include:: ../jobs/components/overview.rst
 
 .. include:: ../jobs/toc.rst
diff --git a/docs/source/user_guide/pipeline/pipeline_step.rst b/docs/source/user_guide/pipeline/pipeline_step.rst
@@ -93,7 +93,7 @@ When constructing a Custom Scrip step ``infrastructure``, you specify the Comput
 
 A Custom Script step can have different types of ``runtime`` depending on the source code you run:
 
-.. include:: ../jobs/_template/runtime_types.rst
+.. include:: ../jobs/components/runtime_non_byoc.rst
 
 All of these runtime options allow you to configure a `Data Science Conda Environment <https://docs.oracle.com/iaas/data-science/using/conda_understand_environments.htm>`__ for running your code. 
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+.. include:: ../jobs/components/runtime_non_byoc.rst`
	`2`	+* :py:class:`~ads.jobs.ContainerRuntime` for container images.