docs(fix): update python and sphinx deps for docs (#473)

engeir · Jun 21, 2024 · a2e4537 · a2e4537
1 parent 124c25a
commit a2e4537
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 16 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -3,8 +3,11 @@ version: 2
 sphinx:
   configuration: docs/conf.py
 formats: all
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
 python:
-  version: "3.8"
   install:
     - requirements: docs/requirements.txt
     - path: .
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,4 @@
-sphinx==7.2.6
-sphinx-rtd-theme==2.0.0
+sphinx-autobuild==2021.3.14
 sphinx-autodoc-typehints==2.2.0
+sphinx-rtd-theme==2.0.0
+sphinx==7.3.7
diff --git a/pyproject.toml b/pyproject.toml
@@ -44,10 +44,10 @@ rye = { dev-dependencies = [
     "xdoctest>=1.1.3",
     "matplotlib>=3.7.5",
     "pre-commit>=3.5.0",
-    "sphinx<7",
-    "sphinx-autodoc-typehints<2",
     "sphinx-rtd-theme>=2.0.0",
     "sphinx-autobuild>=2021.3.14",
+    "sphinx>=7.3.7",
+    "sphinx-autodoc-typehints>=2.2.0",
 ] }
 
 [tool.mypy]

diff --git a/requirements-dev.lock b/requirements-dev.lock
@@ -9,7 +9,7 @@
 #   generate-hashes: false
 
 -e file:.
-alabaster==0.7.13
+alabaster==0.7.16
     # via sphinx
 asteval==0.9.33
     # via lmfit
@@ -122,13 +122,13 @@ six==1.16.0
     # via python-dateutil
 snowballstemmer==2.2.0
     # via sphinx
-sphinx==6.2.1
+sphinx==7.3.7
     # via sphinx-autobuild
     # via sphinx-autodoc-typehints
     # via sphinx-rtd-theme
     # via sphinxcontrib-jquery
 sphinx-autobuild==2021.3.14
-sphinx-autodoc-typehints==1.23.0
+sphinx-autodoc-typehints==2.2.0
 sphinx-rtd-theme==2.0.0
 sphinxcontrib-applehelp==1.0.4
     # via sphinx
@@ -142,14 +142,15 @@ sphinxcontrib-jsmath==1.0.1
     # via sphinx
 sphinxcontrib-qthelp==1.0.3
     # via sphinx
-sphinxcontrib-serializinghtml==1.1.5
+sphinxcontrib-serializinghtml==1.1.10
     # via sphinx
 tomli==2.0.1
     # via coverage
     # via mypy
     # via pre-commit-hooks
     # via pydocstringformatter
     # via pytest
+    # via sphinx
 tornado==6.4.1
     # via livereload
 tqdm==4.66.4

diff --git a/src/inscar/numba_integration.py b/src/inscar/numba_integration.py
@@ -97,13 +97,13 @@ def integrate(
 
     .. math::
 
-       \\begin{aligned}
-       F_{\\mathrm{e}}(\\boldsymbol{k}, \\omega)
-       =1-\\left(i\\frac{X(\\omega)}{X_{\\mathrm{e}}}+\\Lambda_{\\mathrm{e}}\\right)\\int_0^\\infty\\exp\\left
-       \\{-iy\\frac{X(\\omega)}{X_{\\mathrm{e}}}-y\\Lambda_{\\mathrm{e}}\\right.\\\
-       \\left.-\\frac{1}{2X_{\\mathrm{e}}^2}\\left[\\sin^2\\theta(1-\\cos
-       y)+\\frac{1}{2}y^2\\cos^2\\theta\\right]\\right \\}\\textnormal{d}y
-       \\end{aligned}
+       \begin{aligned}
+       F_{\mathrm{e}}(\boldsymbol{k}, \omega)
+       =1-\left(i\frac{X(\omega)}{X_{\mathrm{e}}}+\Lambda_{\mathrm{e}}\right)\int_0^{\infty}\exp\left
+       \{-iy\frac{X(\omega)}{X_{\mathrm{e}}}-y\Lambda_{\mathrm{e}}\right.\\
+       \left.-\frac{1}{2X_{\mathrm{e}}^2}\left[\sin^2\theta(1-\cos
+       y)+\frac{1}{2}y^2\cos^2\theta\right]\right \}\textnormal{d}y
+       \end{aligned}
 
     References
     ----------