Merge pull request #114 from GEB-model/docs

Various updates

.github/workflows/ruff.yml → .github/workflows/ruff-check.yml

@@ -1,4 +1,4 @@
-name: Ruff
+name: Ruff check
 on: [push, pull_request]
 jobs:
   ruff:

.github/workflows/ruff-format.yml

@@ -0,0 +1,10 @@
+name: Ruff format
+on: [push, pull_request]
+jobs:
+  ruff:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+        with:
+          args: 'format --check'

docs/conf.py

@@ -37,6 +37,8 @@
         "--pdf-engine=xelatex",
         "-V",
         "geometry:margin=1.0in",
+        "--citeproc",
+        "--bibliography=../references.bib",
     ],
 )
 os.chdir("..")
@@ -55,6 +57,7 @@
     "sphinx_autodoc_typehints",
     "sphinxcontrib.autoprogram",
     "sphinxcontrib.autoyaml",
+    "sphinxcontrib.bibtex",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -76,6 +79,7 @@
 napoleon_custom_sections = [("Returns", "params_style")]
 autoclass_content = "both"
 autoyaml_level = 3
+bibtex_bibfiles = ["references.bib"]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,