Docs now build, rendering is still messy

dgasmith · May 5, 2024 · d150c39 · d150c39
1 parent 3a03b15
commit d150c39
Show file tree

Hide file tree

Showing 8 changed files with 42 additions and 56 deletions.
diff --git a/.github/workflows/Docs.yaml b/.github/workflows/Docs.yaml
@@ -11,9 +11,9 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: actions/setup-python@v2
+    - uses: actions/setup-python@v5
       with:
         python-version: 3.x
 

diff --git a/.github/workflows/Linting.yml b/.github/workflows/Linting.yml
@@ -12,15 +12,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: [3.7]
+        python-version: [3.12]
         environment: ["min-deps"]
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
-    - uses: conda-incubator/setup-miniconda@v2
+    - uses: conda-incubator/setup-miniconda@v3
       with:
         python-version: ${{ matrix.python-version }}
         mamba-version: "*"

diff --git a/.github/workflows/Tests.yml b/.github/workflows/Tests.yml
@@ -24,9 +24,9 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
-    - uses: conda-incubator/setup-miniconda@v2
+    - uses: conda-incubator/setup-miniconda@v3
       with:
         python-version: ${{ matrix.python-version }}
         mamba-version: "*"

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/api_reference.md b/docs/api_reference.md
@@ -3,81 +3,81 @@
 ### `opt_einsum.contract`
 
 ::: opt_einsum.contract
-    :docstring:
+    <!-- :docstring: -->
 
 ### `opt_einsum.contract_path`
 
 ::: opt_einsum.contract_path
-    :docstring:
+    <!-- :docstring: -->
 
 ### `opt_einsum.contract_expression`
 
 ::: opt_einsum.contract_expression
-    :docstring:
-    :members:
+    <!-- :docstring:
+    :members: -->
 
 ### `opt_einsum.contract.ContractExpression`
 
 ::: opt_einsum.contract.ContractExpression
-    :docstring:
-    :members:
+    <!-- :docstring:
+    :members: -->
 
 ### `opt_einsum.contract.PathInfo`
 
 ::: opt_einsum.contract.PathInfo
-    :docstring:
+    <!-- :docstring: -->
 
 ### `opt_einsum.get_symbol`
 
 ::: opt_einsum.get_symbol
-    :docstring:
+    <!-- :docstring: -->
 
 ### `opt_einsum.shared_intermediates`
 
 ::: opt_einsum.shared_intermediates
-    :docstring:
+    <!-- :docstring: -->
 
 ### `opt_einsum.paths.optimal`
 
 ::: opt_einsum.paths.optimal
-    :docstring:
+    <!-- :docstring: -->
 
 ### `opt_einsum.paths.greedy`
 
 ::: opt_einsum.paths.greedy
-    :docstring:
+    <!-- :docstring: -->
 
 ### `opt_einsum.paths.branch`
 
 ::: opt_einsum.paths.branch
-    :docstring:
+    <!-- :docstring: -->
 
 ### `opt_einsum.paths.PathOptimizer`
 
 ::: opt_einsum.paths.PathOptimizer
-    :docstring:
-    :members:
+    <!-- :docstring:
+    :members: -->
 
 ### `opt_einsum.paths.BranchBound`
 
 ::: opt_einsum.paths.BranchBound
-    :docstring:
-    :members:
+    <!-- :docstring:
+    :members: -->
 
 ### `opt_einsum.path_random.RandomOptimizer`
 
 ::: opt_einsum.path_random.RandomOptimizer
-    :docstring:
-    :members:
+    <!-- :docstring:
+    :members: -->
 
 ### `opt_einsum.path_random.RandomGreedy`
 
 ::: opt_einsum.path_random.RandomGreedy
-    :docstring:
-    :members:
+    <!-- :docstring:
+    :members: -->
 
 ### `opt_einsum.paths.DynamicProgramming`
 
 ::: opt_einsum.paths.DynamicProgramming
-    :docstring:
-    :members:
+    <!-- :docstring:
+    :members: -->
diff --git a/docs/requirements.yml b/docs/requirements.yml
@@ -3,9 +3,9 @@ black
 devtools
 markdown==3.*
 markdown-include==0.*
-mkautodoc==0.1.*
+mkdocstrings[python]==0.25.*
 mkdocs==1.*
 mkdocs-awesome-pages-plugin==2.*
 mkdocs-exclude==1.*
-mkdocs-material==5.*
+mkdocs-material==9.*
 pygments==2.*
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -5,11 +5,18 @@ theme:
   name: material
 
 plugins:
-    - search
-    - awesome-pages
+  - search
+  - awesome-pages
+  - mkdocstrings:
+      default_handler: python
+      handlers:
+        python:
+          # paths: [opt_einsum]
+          options:
+            docstring_style: google
 
 extra_javascript:
-  - javascripts/config.js
+  - javascript/config.js
   - https://polyfill.io/v3/polyfill.min.js?features=es6
   - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
 
@@ -29,7 +36,6 @@ markdown_extensions:
   - pymdownx.extra
   - pymdownx.arithmatex:
       generic: true
-  - mkautodoc
 
 nav:
   - Overview: index.md

diff --git a/opt_einsum/blas.py b/opt_einsum/blas.py
@@ -16,7 +16,7 @@ def can_blas(
     inputs: List[str],
     result: str,
     idx_removed: ArrayIndexType,
-    shapes: Sequence[Tuple[int]] | None = None,
+    shapes: Union[Sequence[Tuple[int]], None] = None,
 ) -> Union[str, bool]:
     """
     Checks if we can use a BLAS call.