[docs] Reorder tutorials to have a common landing page (#1493)

Reorder tutorials to have a common landing page, move rewriter and optimizer tutorials under tutorial tree.
microsoft · May 3, 2024 · a1e46e4 · a1e46e4
1 parent 7e9c9e6
commit a1e46e4
Show file tree

Hide file tree

Showing 18 changed files with 16 additions and 3 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -99,8 +99,6 @@ result = MatmulAdd(x, wt, bias)
 tutorial/index
 api/index
 intermediate_representation/index
-optimizer/index
-rewriter/index
 auto_examples/index
 articles/index
 ```

diff --git a/docs/test/test_documentation_examples.py b/docs/test/test_documentation_examples.py
@@ -50,7 +50,7 @@ def test(*relpath):
 
         test("..", "..", "docs", "examples")
         test("..", "..", "docs", "tutorial", "examples")
-        test("..", "..", "docs", "rewriter", "examples")
+        test("..", "..", "docs", "tutorial", "rewriter", "examples")
 
 
 if __name__ == "__main__":

diff --git a/docs/tutorial/index.md b/docs/tutorial/index.md
@@ -6,6 +6,13 @@ myst:
 
 # Tutorial
 
+## Welcome to ONNX Script Tutorials
+
+For extended tutorials on how to use the **Optimizer** and **Rewriter** tools, refer to the relevant sub-sections within the Tutorial section.
+- <project:optimizer/optimize.md>
+- <project:rewriter/rewrite_patterns.md>
+
+
 In this tutorial, we illustrate the features supported by {{ onnxscript }} using examples.
 
 ## Basic Features
@@ -257,3 +264,11 @@ ONNX perspective, the two assignments to *g* represent two distinct tensors
 
 ```{literalinclude} examples/outerscope_redef_error.py
 ```
+
+```{toctree}
+:maxdepth: 1
+
+optimizer/index
+rewriter/index
+```
+
diff --git a/docs/optimizer/index.md → docs/tutorial/optimizer/index.md b/docs/optimizer/index.md → docs/tutorial/optimizer/index.md
diff --git a/docs/optimizer/optimize.md → docs/tutorial/optimizer/optimize.md b/docs/optimizer/optimize.md → docs/tutorial/optimizer/optimize.md
diff --git a/docs/rewriter/examples/broadcast_matmul.py → ...ial/rewriter/examples/broadcast_matmul.py b/docs/rewriter/examples/broadcast_matmul.py → ...ial/rewriter/examples/broadcast_matmul.py
diff --git a/docs/rewriter/examples/erfgelu.py → docs/tutorial/rewriter/examples/erfgelu.py b/docs/rewriter/examples/erfgelu.py → docs/tutorial/rewriter/examples/erfgelu.py
diff --git a/docs/rewriter/examples/img/broadcast_01.png → ...al/rewriter/examples/img/broadcast_01.png b/docs/rewriter/examples/img/broadcast_01.png → ...al/rewriter/examples/img/broadcast_01.png
diff --git a/docs/rewriter/examples/img/broadcast_02.png → ...al/rewriter/examples/img/broadcast_02.png b/docs/rewriter/examples/img/broadcast_02.png → ...al/rewriter/examples/img/broadcast_02.png
diff --git a/docs/rewriter/examples/img/erfgelu_01.png → ...rial/rewriter/examples/img/erfgelu_01.png b/docs/rewriter/examples/img/erfgelu_01.png → ...rial/rewriter/examples/img/erfgelu_01.png
diff --git a/docs/rewriter/examples/img/erfgelu_02.png → ...rial/rewriter/examples/img/erfgelu_02.png b/docs/rewriter/examples/img/erfgelu_02.png → ...rial/rewriter/examples/img/erfgelu_02.png
diff --git a/...riter/examples/img/erfgelu_03_commute.png → ...riter/examples/img/erfgelu_03_commute.png b/...riter/examples/img/erfgelu_03_commute.png → ...riter/examples/img/erfgelu_03_commute.png
diff --git a/...riter/examples/img/erfgelu_04_commute.png → ...riter/examples/img/erfgelu_04_commute.png b/...riter/examples/img/erfgelu_04_commute.png → ...riter/examples/img/erfgelu_04_commute.png
diff --git a/...riter/examples/img/erfgelu_05_commute.png → ...riter/examples/img/erfgelu_05_commute.png b/...riter/examples/img/erfgelu_05_commute.png → ...riter/examples/img/erfgelu_05_commute.png
diff --git a/...riter/examples/img/erfgelu_06_commute.png → ...riter/examples/img/erfgelu_06_commute.png b/...riter/examples/img/erfgelu_06_commute.png → ...riter/examples/img/erfgelu_06_commute.png
diff --git a/...riter/examples/img/erfgelu_07_commute.png → ...riter/examples/img/erfgelu_07_commute.png b/...riter/examples/img/erfgelu_07_commute.png → ...riter/examples/img/erfgelu_07_commute.png
diff --git a/docs/rewriter/index.md → docs/tutorial/rewriter/index.md b/docs/rewriter/index.md → docs/tutorial/rewriter/index.md
diff --git a/docs/rewriter/rewrite_patterns.md → docs/tutorial/rewriter/rewrite_patterns.md b/docs/rewriter/rewrite_patterns.md → docs/tutorial/rewriter/rewrite_patterns.md