diff --git a/docs/website/docs/building-from-source/android.md b/docs/website/docs/building-from-source/android.md index 9fe2ddd18c50..0328340ca83a 100644 --- a/docs/website/docs/building-from-source/android.md +++ b/docs/website/docs/building-from-source/android.md @@ -3,6 +3,7 @@ hide: - tags tags: - Android +icon: simple/android --- # Android cross-compilation diff --git a/docs/website/docs/building-from-source/getting-started.md b/docs/website/docs/building-from-source/getting-started.md index 38f5d8412d5c..1379ab9aa5fe 100644 --- a/docs/website/docs/building-from-source/getting-started.md +++ b/docs/website/docs/building-from-source/getting-started.md @@ -1,3 +1,7 @@ +--- +icon: octicons/bookmark-16 +--- + # Getting started ## :octicons-download-16: Prerequisites diff --git a/docs/website/docs/building-from-source/ios.md b/docs/website/docs/building-from-source/ios.md index 737703deac53..cfcfce4ac815 100644 --- a/docs/website/docs/building-from-source/ios.md +++ b/docs/website/docs/building-from-source/ios.md @@ -3,6 +3,7 @@ hide: - tags tags: - iOS +icon: simple/apple --- # iOS cross-compilation diff --git a/docs/website/docs/building-from-source/riscv.md b/docs/website/docs/building-from-source/riscv.md index 5caaa17e4a8b..b305895cbe41 100644 --- a/docs/website/docs/building-from-source/riscv.md +++ b/docs/website/docs/building-from-source/riscv.md @@ -3,6 +3,7 @@ hide: - tags tags: - CPU +icon: octicons/cpu-16 --- # RISC-V cross-compilation diff --git a/docs/website/docs/guides/deployment-configurations/bare-metal.md b/docs/website/docs/guides/deployment-configurations/bare-metal.md index 8b5197ede70c..33d2ed3ec11a 100644 --- a/docs/website/docs/guides/deployment-configurations/bare-metal.md +++ b/docs/website/docs/guides/deployment-configurations/bare-metal.md @@ -3,6 +3,7 @@ hide: - tags tags: - CPU +icon: octicons/cpu-16 --- # Running on a Bare-Metal Platform diff --git a/docs/website/docs/guides/deployment-configurations/cpu.md b/docs/website/docs/guides/deployment-configurations/cpu.md index 3f3ca37da28e..cb430def6102 100644 --- a/docs/website/docs/guides/deployment-configurations/cpu.md +++ b/docs/website/docs/guides/deployment-configurations/cpu.md @@ -3,6 +3,7 @@ hide: - tags tags: - CPU +icon: octicons/cpu-16 --- # CPU Deployment diff --git a/docs/website/docs/guides/deployment-configurations/gpu-cuda-rocm.md b/docs/website/docs/guides/deployment-configurations/gpu-cuda-rocm.md index 1ad06d09374f..a8a98a033a3f 100644 --- a/docs/website/docs/guides/deployment-configurations/gpu-cuda-rocm.md +++ b/docs/website/docs/guides/deployment-configurations/gpu-cuda-rocm.md @@ -4,6 +4,7 @@ hide: tags: - GPU - CUDA +icon: octicons/server-16 --- # GPU Deployment using CUDA and ROCm diff --git a/docs/website/docs/guides/deployment-configurations/gpu-vulkan.md b/docs/website/docs/guides/deployment-configurations/gpu-vulkan.md index f32dd2b0b461..5cd397b2d861 100644 --- a/docs/website/docs/guides/deployment-configurations/gpu-vulkan.md +++ b/docs/website/docs/guides/deployment-configurations/gpu-vulkan.md @@ -4,6 +4,7 @@ hide: tags: - GPU - Vulkan +icon: octicons/server-16 --- # GPU Deployment using Vulkan diff --git a/docs/website/docs/guides/developer-tips.md b/docs/website/docs/guides/developer-tips.md index 597c636f1135..9fd8b364c56b 100644 --- a/docs/website/docs/guides/developer-tips.md +++ b/docs/website/docs/guides/developer-tips.md @@ -1,3 +1,8 @@ +--- +status: new +icon: material/lightbulb-on +--- + # IREE developer tips and tricks The IREE compiler is built using [MLIR](https://mlir.llvm.org/), so it naturally @@ -62,11 +67,11 @@ then be loaded and executed using IREE's runtime. C source modules provide low level connection points for constrained environments like bare metal platforms. -By default, `.vmfb` files can be opened as zip files: +By default, `.vmfb` files can be opened as zip files: (1) +{ .annotate } - +1. Setting `--iree-vm-emit-polyglot-zip=false` will disable this feature and + decrease file size slightly ```console $ unzip -d simple_abs_cpu ./simple_abs_cpu.vmfb diff --git a/docs/website/docs/guides/ml-frameworks/jax.md b/docs/website/docs/guides/ml-frameworks/jax.md index 4ce273d11a12..a123f1affbe7 100644 --- a/docs/website/docs/guides/ml-frameworks/jax.md +++ b/docs/website/docs/guides/ml-frameworks/jax.md @@ -4,6 +4,7 @@ hide: tags: - Python - JAX +icon: simple/python --- # JAX Integration diff --git a/docs/website/docs/guides/ml-frameworks/pytorch.md b/docs/website/docs/guides/ml-frameworks/pytorch.md index 56c766d0e16b..c2c8877dc49d 100644 --- a/docs/website/docs/guides/ml-frameworks/pytorch.md +++ b/docs/website/docs/guides/ml-frameworks/pytorch.md @@ -4,6 +4,7 @@ hide: tags: - Python - PyTorch +icon: simple/pytorch --- # PyTorch Integration diff --git a/docs/website/docs/guides/ml-frameworks/tensorflow.md b/docs/website/docs/guides/ml-frameworks/tensorflow.md index a843ee8d5338..5ca0ce5116ed 100644 --- a/docs/website/docs/guides/ml-frameworks/tensorflow.md +++ b/docs/website/docs/guides/ml-frameworks/tensorflow.md @@ -4,6 +4,7 @@ hide: tags: - Python - TensorFlow +icon: simple/tensorflow --- # TensorFlow Integration diff --git a/docs/website/docs/guides/ml-frameworks/tflite.md b/docs/website/docs/guides/ml-frameworks/tflite.md index dd8d73c380ae..8d1b70452f77 100644 --- a/docs/website/docs/guides/ml-frameworks/tflite.md +++ b/docs/website/docs/guides/ml-frameworks/tflite.md @@ -4,6 +4,7 @@ hide: tags: - Python - TensorFlow +icon: simple/tensorflow --- # TFLite Integration diff --git a/docs/website/docs/reference/bindings/c-api.md b/docs/website/docs/reference/bindings/c-api.md index 7ca98b7948c1..4efa0ba1fce2 100644 --- a/docs/website/docs/reference/bindings/c-api.md +++ b/docs/website/docs/reference/bindings/c-api.md @@ -1,3 +1,7 @@ +--- +icon: octicons/code-16 +--- + # C API bindings ## Overview diff --git a/docs/website/docs/reference/bindings/python.md b/docs/website/docs/reference/bindings/python.md index 9bf655a05d74..8707efcf4966 100644 --- a/docs/website/docs/reference/bindings/python.md +++ b/docs/website/docs/reference/bindings/python.md @@ -3,6 +3,7 @@ hide: - tags tags: - Python +icon: simple/python --- # Python bindings diff --git a/docs/website/docs/reference/extensions.md b/docs/website/docs/reference/extensions.md index 1219937fbd89..188733abcbd3 100644 --- a/docs/website/docs/reference/extensions.md +++ b/docs/website/docs/reference/extensions.md @@ -1,3 +1,13 @@ +--- +hide: + - tags +tags: + - JAX + - PyTorch + - TensorFlow +icon: octicons/gear-16 +--- + # Extension mechanisms !!! Note diff --git a/docs/website/docs/reference/glossary.md b/docs/website/docs/reference/glossary.md index 4852d5c3f5d9..ea389f299b26 100644 --- a/docs/website/docs/reference/glossary.md +++ b/docs/website/docs/reference/glossary.md @@ -5,6 +5,7 @@ tags: - JAX - PyTorch - TensorFlow +icon: octicons/book-16 --- # Glossary diff --git a/docs/website/docs/reference/mlir-dialects/index.md b/docs/website/docs/reference/mlir-dialects/index.md index 39686fd6d664..8db7208a5337 100644 --- a/docs/website/docs/reference/mlir-dialects/index.md +++ b/docs/website/docs/reference/mlir-dialects/index.md @@ -1,3 +1,7 @@ +--- +icon: simple/llvm +--- + # MLIR dialects These pages contain automatically generated documentation for the MLIR dialects diff --git a/docs/website/docs/reference/optimization-options.md b/docs/website/docs/reference/optimization-options.md index 7c9dc91b40ce..de8f668c3458 100644 --- a/docs/website/docs/reference/optimization-options.md +++ b/docs/website/docs/reference/optimization-options.md @@ -1,3 +1,7 @@ +--- +icon: octicons/rocket-16 +--- + # Optimization options This page documents various supported flags for optimizing IREE programs. Each diff --git a/docs/website/mkdocs.yml b/docs/website/mkdocs.yml index 1431d9aefd86..70fdadbf6f79 100644 --- a/docs/website/mkdocs.yml +++ b/docs/website/mkdocs.yml @@ -71,6 +71,9 @@ extra: link: https://groups.google.com/forum/#!forum/iree-discuss name: IREE Discuss Google Group + status: + new: Recently added + extra_css: - assets/stylesheets/extra.css - assets/stylesheets/openxla.css diff --git a/docs/website/requirements.txt b/docs/website/requirements.txt index 887d1fd079d3..909284b67d64 100644 --- a/docs/website/requirements.txt +++ b/docs/website/requirements.txt @@ -1,4 +1,2 @@ -# TODO(scotttodd): pin versions to control how often we pull in updates? - -mkdocs-material -mkdocs-redirects +mkdocs-material==9.2.0b1 +mkdocs-redirects==1.2.1 diff --git a/third_party/mkdocs-material/overrides/partials/header.html b/third_party/mkdocs-material/overrides/partials/header.html index d9579701575c..ac1dd3d6b223 100644 --- a/third_party/mkdocs-material/overrides/partials/header.html +++ b/third_party/mkdocs-material/overrides/partials/header.html @@ -20,10 +20,12 @@ IN THE SOFTWARE. --> - + {% set class = "md-header" %} {% if "navigation.tabs.sticky" in features %} - {% set class = class ~ " md-header--lifted" %} + {% set class = class ~ " md-header--shadow md-header--lifted" %} +{% elif "navigation.tabs" not in features %} + {% set class = class ~ " md-header--shadow" %} {% endif %} @@ -52,14 +54,15 @@ aria-label="{{ config.site_name }}" data-md-component="logo" > -
- {{ config.site_name }} -
+
+ {{ config.site_name }} +
@@ -78,37 +81,41 @@ - {% if not config.theme.palette is mapping %} -
- {% for option in config.theme.palette %} - {% set scheme = option.scheme | d("default", true) %} - + {% for option in config.theme.palette %} + {% set scheme = option.scheme | d("default", true) %} + {% set primary = option.primary | d("indigo", true) %} + {% set accent = option.accent | d("indigo", true) %} + {% if option.toggle %} - aria-label="{{ option.toggle.name }}" - {% else %} - aria-hidden="true" + {% endif %} - type="radio" - name="__palette" - id="__palette_{{ loop.index }}" - /> - {% if option.toggle %} - - {% endif %} - {% endfor %} -
+ {% endfor %} + + {% endif %} {% endif %} @@ -144,7 +151,8 @@ {% if "material/search" in config.plugins %} diff --git a/third_party/mkdocs-material/overrides/partials/nav.html b/third_party/mkdocs-material/overrides/partials/nav.html index 6cdb945757c9..0c5c775123cc 100644 --- a/third_party/mkdocs-material/overrides/partials/nav.html +++ b/third_party/mkdocs-material/overrides/partials/nav.html @@ -20,7 +20,9 @@ IN THE SOFTWARE. --> - +{% import "partials/nav-item.html" as item with context %} + + {% set class = "md-nav md-nav--primary" %} {% if "navigation.tabs" in features %} {% set class = class ~ " md-nav--lifted" %} @@ -29,7 +31,7 @@ {% set class = class ~ " md-nav--integrated" %} {% endif %} - +