Skip to content

Commit

Permalink
Allows for versioned docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dgasmith committed Sep 26, 2024
1 parent c15aec2 commit a663b75
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/Docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/paths/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.*
Expand Down
6 changes: 6 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -58,6 +59,11 @@ plugins:
summary: true
unwrap_annotated: true

extra:
version:
provider: mike
default: stable

extra_javascript:
- javascript/config.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
Expand Down

0 comments on commit a663b75

Please sign in to comment.