diff --git a/.github/workflows/Docs.yaml b/.github/workflows/Docs.yaml index 3c7267c..5c5348a 100644 --- a/.github/workflows/Docs.yaml +++ b/.github/workflows/Docs.yaml @@ -28,4 +28,4 @@ jobs: # Only deploy if main, otherwise just build for testing - name: Deploy if: endsWith(github.ref, '/main') - run: mkdocs gh-deploy --force + run: mike deploy --push --update-aliases latest diff --git a/docs/paths/introduction.md b/docs/paths/introduction.md index 6943dcc..c9e8a93 100644 --- a/docs/paths/introduction.md +++ b/docs/paths/introduction.md @@ -3,7 +3,7 @@ Performing an optimized tensor contraction to speed up `einsum` involves two key stages: -1. Finding a pairwise contraction order, or **'path'**. +1. Finding a pairwise contraction order, or `path`. 2. Performing the sequence of contractions given this path. The better the quality of path found in the first step, the quicker the actual diff --git a/docs/requirements.yml b/docs/requirements.yml index b7388ce..43c9ad9 100644 --- a/docs/requirements.yml +++ b/docs/requirements.yml @@ -3,6 +3,7 @@ black devtools markdown==3.* markdown-include==0.* +mike==2.1.* mkdocstrings[python]==0.25.* mkdocs==1.* mkdocs-awesome-pages-plugin==2.* diff --git a/mkdocs.yml b/mkdocs.yml index 365a36d..a4a93ed 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,5 @@ site_name: Optimized Einsum +site_url: https://dgasmith.github.io/opt_einsum/ repo_url: https://github.com/dgasmith/opt_einsum repo_name: dgasmith/opt_einsum theme: @@ -58,6 +59,12 @@ plugins: summary: true unwrap_annotated: true +extra: + version: + provider: mike + default: stable + javascript_dir: javascript + extra_javascript: - javascript/config.js - https://polyfill.io/v3/polyfill.min.js?features=es6