Skip to content

Commit

Permalink
Move snippets and exclude via exclude_docs
Browse files Browse the repository at this point in the history
Moves the snippets to s `snippets` subfolder and adds those folders to
`exclude_docs` thus that the snippets get not included as separate files
in the site.
  • Loading branch information
marbre committed Oct 16, 2024
1 parent ae74fb8 commit 800842f
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 12 deletions.
6 changes: 3 additions & 3 deletions docs/website/docs/guides/deployment-configurations/cpu.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Python packages are regularly published to
[Python Bindings](../../reference/bindings/python.md) page for more details.
The core `iree-compiler` package includes the LLVM-based CPU compiler:

--8<-- "docs/website/docs/guides/deployment-configurations/_iree-compiler-from-release.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md"

#### :material-hammer-wrench: Build the compiler from source

Expand Down Expand Up @@ -74,7 +74,7 @@ You can check for CPU support by looking for the `local-sync` and `local-task`
drivers:

```console hl_lines="5 6"
--8<-- "docs/website/docs/guides/deployment-configurations/_iree-run-module-driver-list.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-run-module-driver-list.md"
```

#### :octicons-package-16: Download the runtime from a release
Expand All @@ -84,7 +84,7 @@ Python packages are regularly published to
[Python Bindings](../../reference/bindings/python.md) page for more details.
The core `iree-runtime` package includes the local CPU HAL drivers:

--8<-- "docs/website/docs/guides/deployment-configurations/_iree-runtime-from-release.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md"

#### :material-hammer-wrench: Build the runtime from source

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Python packages are regularly published to
[Python Bindings](../../reference/bindings/python.md) page for more details.
The core `iree-compiler` package includes the CUDA compiler:

--8<-- "docs/website/docs/guides/deployment-configurations/_iree-compiler-from-release.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md"

#### :material-hammer-wrench: Build the compiler from source

Expand All @@ -53,7 +53,7 @@ Next you will need to get an IREE runtime that includes the CUDA HAL driver.
You can check for CUDA support by looking for a matching driver and device:

```console hl_lines="3"
--8<-- "docs/website/docs/guides/deployment-configurations/_iree-run-module-driver-list.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-run-module-driver-list.md"
```

```console hl_lines="3"
Expand All @@ -71,7 +71,7 @@ Python packages are regularly published to
[Python Bindings](../../reference/bindings/python.md) page for more details.
The core `iree-runtime` package includes the CUDA HAL driver:

--8<-- "docs/website/docs/guides/deployment-configurations/_iree-runtime-from-release.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md"

#### :material-hammer-wrench: Build the runtime from source

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Python packages are regularly published to
[Python Bindings](../../reference/bindings/python.md) page for more details.
The core `iree-compiler` package includes the ROCm compiler:

--8<-- "docs/website/docs/guides/deployment-configurations/_iree-compiler-from-release.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md"

#### :material-hammer-wrench: Build the compiler from source

Expand All @@ -55,7 +55,7 @@ Next you will need to get an IREE runtime that includes the HIP HAL driver.
You can check for HIP support by looking for a matching driver and device:

```console hl_lines="4"
--8<-- "docs/website/docs/guides/deployment-configurations/_iree-run-module-driver-list.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-run-module-driver-list.md"
```

```console hl_lines="3"
Expand All @@ -73,7 +73,7 @@ Python packages are regularly published to
[Python Bindings](../../reference/bindings/python.md) page for more details.
The core `iree-runtime` package includes the HIP HAL driver:

--8<-- "docs/website/docs/guides/deployment-configurations/_iree-runtime-from-release.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md"

#### :material-hammer-wrench: Build the runtime from source

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Python packages are regularly published to
[Python Bindings](../../reference/bindings/python.md) page for more details.
The core `iree-compiler` package includes the SPIR-V compiler:

--8<-- "docs/website/docs/guides/deployment-configurations/_iree-compiler-from-release.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-compiler-from-release.md"

#### :material-hammer-wrench: Build the compiler from source

Expand All @@ -108,7 +108,7 @@ Next you will need to get an IREE runtime that supports the Vulkan HAL driver.
You can check for Vulkan support by looking for a matching driver and device:

```console hl_lines="7"
--8<-- "docs/website/docs/guides/deployment-configurations/_iree-run-module-driver-list.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-run-module-driver-list.md"
```

```console hl_lines="6"
Expand All @@ -127,7 +127,7 @@ Python packages are regularly published to
[Python Bindings](../../reference/bindings/python.md) page for more details.
The core `iree-runtime` package includes the Vulkan HAL drivers:

--8<-- "docs/website/docs/guides/deployment-configurations/_iree-runtime-from-release.md"
--8<-- "docs/website/docs/guides/deployment-configurations/snippets/_iree-runtime-from-release.md"

#### :material-hammer-wrench: Build the runtime from source

Expand Down
1 change: 1 addition & 0 deletions docs/website/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,7 @@ extra_css:
exclude_docs: |
*.gz
assets/images/README.md
**/snippets/*.md
copyright: Copyright &copy; 2024 The IREE Authors

Expand Down

0 comments on commit 800842f

Please sign in to comment.