Merge pull request #6914 from smokestacklightnin/ci/docs/followup

Documentation Followup

Author: peytondmurray

.github/workflows/cd-docs.yml

@@ -39,7 +39,7 @@ jobs:
             mkdocs-material-
 
       - name: Install Dependencies
-        run: pip install mkdocs mkdocs-material mkdocstrings[python] griffe-inherited-docstrings mkdocs-autorefs mkdocs-jupyter mkdocs-caption
+        run: pip install mkdocs mkdocs-material mkdocstrings[python] griffe-inherited-docstrings mkdocs-autorefs mkdocs-jupyter mkdocs-caption markdown-grid-tables
 
       - name: Deploy to GitHub Pages
         run: mkdocs gh-deploy --force

docs/api/v1/extensions.md

@@ -1,3 +1,5 @@
 # Extension
 
 ::: tfx.v1.extensions
+    options:
+      show_if_no_docstring: true

docs/api/v1/index.md

@@ -0,0 +1,17 @@
+# Modules
+
+[components][tfx.v1.components] module: TFX components module.
+
+[dsl][tfx.v1.dsl] module: TFX DSL module.
+
+[extensions][tfx.v1.extensions] module: TFX extensions module.
+
+[orchestration][tfx.v1.orchestration] module: TFX orchestration module.
+
+[proto][tfx.v1.proto] module: TFX proto module.
+
+[testing][tfx.v1.testing] module: Public testing modules for TFX.
+
+[types][tfx.v1.types] module: TFX types module.
+
+[utils][tfx.v1.utils] module: TFX utils module.

docs/api/v1/orchestration.md

@@ -1,3 +1,5 @@
 # Orchestration
 
 ::: tfx.v1.orchestration
+    options:
+	  show_if_no_docstring: true

docs/api/v1/root.md

@@ -1,3 +1,5 @@
 # Testing
 
 ::: tfx.v1.testing
+    options:
+	  show_if_no_docstring: true

docs/api/v1/testing.md

@@ -1,3 +1,5 @@
 # Utils
 
 ::: tfx.v1.utils
+    options:
+	  show_if_no_docstring: true

docs/api/v1/utils.md

@@ -157,7 +157,7 @@ template.
     implement a pipeline for tabular data using the TFX standard components. If
     you are moving an existing ML workflow into a pipeline, you may need to
     revise your code to make full use of
-    [TFX standard components](index.md#tfx_standard_components). You may also need
+    [TFX standard components](index.md#tfx-standard-components). You may also need
     to create [custom components](understanding_custom_components.md) that
     implement features which are unique to your workflow or that are not yet
     supported by TFX standard components.
@@ -198,7 +198,7 @@ without using a template.
     features such as data augmentation.
 
     *   Learn more about
-        [standard TFX components](index.md#tfx_standard_components).
+        [standard TFX components](index.md#tfx-standard-components).
     *   Learn more about [custom components](understanding_custom_components.md).
 
 1.  Create a script file to define your pipeline using the following example.

docs/guide/build_local_pipeline.md

@@ -1,11 +1,13 @@
 # Building TFX pipelines
 
-Note: For a conceptual view of TFX Pipelines, see
-[Understanding TFX Pipelines](understanding_tfx_pipelines.md).
+!!! Note
+    For a conceptual view of TFX Pipelines, see
+    [Understanding TFX Pipelines](understanding_tfx_pipelines.md).
 
-Note: Want to build your first pipeline before you dive into the details? Get
-started
-[building a pipeline using a template](build_local_pipeline.md#build-a-pipeline-using-a-template).
+!!!Note
+    Want to build your first pipeline before you dive into the details? Get
+    started
+    [building a pipeline using a template](build_local_pipeline.md#build-a-pipeline-using-a-template).
 
 ## Using the `Pipeline` class
 
@@ -61,9 +63,10 @@ statistics. In this example, the instance of `StatisticsGen` must follow
 
 ### Task-based dependencies
 
-Note: Using task-based dependencies is typically not recommended. Defining the
-execution graph with artifact dependencies lets you take advantage of the
-automatic artifact lineage tracking and caching features of TFX.
+!!! Note
+    Using task-based dependencies is typically not recommended. Defining the
+    execution graph with artifact dependencies lets you take advantage of the
+    automatic artifact lineage tracking and caching features of TFX.
 
 You can also define task-based dependencies using your component's
 [`add_upstream_node` and `add_downstream_node`](https://github.com/tensorflow/tfx/blob/master/tfx/components/base/base_node.py){: .external }
@@ -75,7 +78,7 @@ that the current component must be executed before the specified component.
 
 The easiest way to get a pipeline set up quickly, and to see how all the pieces
 fit together, is to use a template. Using templates is covered in [Building a
-TFX Pipeline Locally](build_local_pipeline).
+TFX Pipeline Locally](../build_local_pipeline).
 
 ## Caching