fix formatting + add requirements for docs build

.readthedocs.yaml

@@ -11,5 +11,4 @@ sphinx:
 
 python:
  install:
- - method: pip
- path: .
+ - requirements: doc/requirements.txt

doc/AC_Stark_primer.ipynb

@@ -186,7 +186,7 @@
  " lmax,\n",
  " edN=1,\n",
  " progressOutput=False,\n",
- " debugOutput=False\n",
+ " debugOutput=False,\n",
  " )\n",
  " m.defineShirleyHamiltonian(fn=1)\n",
  " m.diagonalise(Efields, freq, progressOutput=True)\n",
@@ -348,7 +348,7 @@
  " lmax,\n",
  " edN=1,\n",
  " progressOutput=False,\n",
- " debugOutput=False\n",
+ " debugOutput=False,\n",
  ")\n",
  "calc.defineShirleyHamiltonian(fn=1)\n",
  "calc.diagonalise(Efields, freqs, progressOutput=True)"
@@ -962,7 +962,7 @@
  " lmax,\n",
  " edN=1,\n",
  " progressOutput=False,\n",
- " debugOutput=False\n",
+ " debugOutput=False,\n",
  ")\n",
  "calc_rwa.findDipoleCoupledStates(debugOutput=True)\n",
  "calc_rwa.makeRWA(eField, freqs)"

doc/conf.py

@@ -14,19 +14,17 @@
 
 import sys
 import os
-
+from mock import Mock as MagicMock
 
 sys.path.insert(0, os.path.abspath(".."))
 # resolve problem with not having _tkinter on server used for documentation building
 autodoc_mock_imports = ["_tkinter"]
-import matplotlib
+import matplotlib # noqa: E402
 
 matplotlib.use("agg")
 
 html_extra_path = ["./_static/"]
 
-from mock import Mock as MagicMock
-
 
 class Mock(MagicMock):
  @classmethod
@@ -172,7 +170,7 @@ def __getattr__(cls, name):
 
 # The theme to use for HTML and HTML Help pages. See the documentation for
 # a list of builtin themes.
-##html_theme = 'alabaster'
+# html_theme = 'alabaster'
 
 # import sphinx_rtd_theme
 
@@ -316,9 +314,9 @@ def __getattr__(cls, name):
  # The paper size ('letterpaper' or 'a4paper').
  "papersize": "a4paper",
  # The font size ('10pt', '11pt' or '12pt').
- #'pointsize': '10pt',
+ # 'pointsize': '10pt',
  # Additional stuff for the LaTeX preamble.
- #'preamble': '',
+ # 'preamble': '',
  # Latex figure (float) alignment
  "figure_align": "htbp",
 }

doc/math_and_io_primitives.rst

@@ -9,4 +9,5 @@ as well as commonly used input/output functions.
  :maxdepth: 2
 
  numerics_and_io
- angular_algebra
+ angular_algebra
+