Use NVIDIA's exporter for LLM documentation

.readthedocs.yml

@@ -7,9 +7,13 @@ build:
   jobs:
     create_environment:
       - asdf plugin add pixi
-      - asdf install pixi latest
-      - asdf global pixi latest
+      - asdf install pixi 0.83.0
+      - asdf global pixi 0.83.0
+    install:
+      - pixi install --locked -e docs
     post_build:
-      - pixi run -e docs build-docs
+      - pixi run --locked -e docs build-docs
+      # The exporter can log a failed Markdown subprocess without failing Sphinx.
+      - test -s docs/build/html/llms.txt
       - mkdir --parents $READTHEDOCS_OUTPUT/html/
       - cp -a docs/build/html/. "$READTHEDOCS_OUTPUT/html" && rm -r docs/build

docs/source/conf.py

@@ -51,9 +51,16 @@
     "sphinx_design",
     "sphinxcontrib.mermaid",
     "sphinx_llm.txt",
-    "sphinx_llms_txt",
 ]
 
+# Reuse the HTML doctrees so Markdown generation does not execute notebooks again.
+llms_txt_build_parallel = False
+llms_txt_full_build = False
+llms_txt_description = (
+    "Documentation for optimagic, a Python package for numerical optimization."
+)
+markdown_http_base = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
 myst_enable_extensions = [
     "colon_fence",
     "dollarmath",
@@ -174,6 +181,12 @@
 # -- Options for myst-nb  ----------------------------------------
 nb_execution_mode = "force"  # "off", "force", "cache", "auto"
 nb_execution_allow_errors = False
+nb_execution_raise_on_error = True
+# Preserve notebook text outputs in sphinx-llm's Markdown builder.
+nb_mime_priority_overrides = [
+    ("llms-markdown", "text/markdown", 10),
+    ("llms-markdown", "text/plain", 20),
+]
 nb_merge_streams = True
 nb_scroll_outputs = True
 

docs/source/how_to/how_to_add_optimizers.ipynb

@@ -421,10 +421,13 @@
     "    needs_jac=False,\n",
     "    # does the optimizer need the hessian? -> no, gaco is derivative free\n",
     "    needs_hess=False,\n",
+    "    # does the optimizer require finite bounds? -> yes\n",
+    "    needs_bounds=True,\n",
     "    # does the optimizer support parallelism? -> yes\n",
     "    supports_parallelism=True,\n",
     "    # does the optimizer support bounds? -> yes\n",
     "    supports_bounds=True,\n",
+    "    supports_infinite_bounds=False,\n",
     "    # does the optimizer support linear constraints? -> no\n",
     "    supports_linear_constraints=False,\n",
     "    # does the optimizer support nonlinear constraints? -> no\n",

docs/source/index.md

@@ -1,4 +1,4 @@
-# 
+# optimagic
 
 <div style="padding-top: 50px;">
 </div>

pyproject.toml

@@ -471,8 +471,7 @@ sphinx = ">=8.2.3"
 sphinxcontrib-bibtex = "*"
 sphinx-copybutton = "*"
 sphinx-design = "*"
-sphinx-llm = "*"
-sphinx-llms-txt = "*"
+sphinx-llm = ">=1.1.0"
 ipython = "*"
 ipython_genutils = "*"
 myst-nb = "*"
@@ -485,7 +484,7 @@ sphinxcontrib-mermaid = "*"
 intersphinx-registry = "*"
 
 [tool.pixi.feature.docs.tasks]
-build-docs = { cmd = "make html", cwd = "docs", description = "Build the HTML documentation" }
+build-docs = { cmd = "make html SPHINXOPTS=-T", cwd = "docs", description = "Build the HTML documentation" }
 
 # --- Compat features (version overrides for backward-compat CI) ---------------------
 [tool.pixi.feature.old-plotly.dependencies]