From 998aa1c5bcf2c497f6d5e95737a3d02f2eab781b Mon Sep 17 00:00:00 2001 From: jlnav Date: Fri, 30 Jan 2026 13:42:47 -0600 Subject: [PATCH 1/7] deps in place to fix ax issues (at least locally), experimenting with pixi envs and builds for docs --- .readthedocs.yml | 17 +++++++++-------- docs/requirements.txt | 8 -------- pixi.lock | 4 ++-- pyproject.toml | 7 +++++++ 4 files changed, 18 insertions(+), 18 deletions(-) delete mode 100644 docs/requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml index 50b0395fae..27ae191746 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -4,17 +4,18 @@ build: os: "ubuntu-22.04" tools: python: "3.10" + commands: + - asdf plugin add pixi + - asdf install pixi latest + - asdf global pixi latest + - pixi run -e docs build-docs + - pixi run -e docs build-pdf + - mkdir -p $READTHEDOCS_OUTPUT/html/ + - cp -r docs/_build/html/** $READTHEDOCS_OUTPUT/html/ + - cp -r docs/_build/latex/** $READTHEDOCS_OUTPUT/pdf/ sphinx: configuration: docs/conf.py formats: - pdf - -python: - install: - - requirements: docs/requirements.txt - - method: pip - path: . - extra_requirements: - - docs diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 7c68cd9a43..0000000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,8 +0,0 @@ -sphinx<10 -sphinxcontrib-bibtex -sphinxcontrib-spelling -autodoc_pydantic -sphinx-design -numpy -sphinx_rtd_theme>1 -sphinx-copybutton diff --git a/pixi.lock b/pixi.lock index d019ac56e2..de36f54388 100644 --- a/pixi.lock +++ b/pixi.lock @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:a758e95c16d5e476bec89fd4351a7dc614057b22b7bd2c65cf982604ab45d4c5 -size 1087911 +oid sha256:0c9c239a20f516658e111e78a08e9e32b4542147ac73d2100e653712fe99d171 +size 1094776 diff --git a/pyproject.toml b/pyproject.toml index 4549355b65..66a6581c7b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -136,6 +136,12 @@ mypy = ">=1.19.1,<2" types-psutil = ">=6.1.0.20241221,<7" types-pyyaml = ">=6.0.12.20250915,<7" +[tool.pixi.tasks.build-docs] +cmd = "cd docs && make html" + +[tool.pixi.tasks.build-pdf] +cmd = "cd docs && make latex" + # Linux dependencies, only for extra tests [tool.pixi.feature.extra.target.linux-64.dependencies] scikit-build = "*" @@ -208,6 +214,7 @@ extra = [ "redis>=7.1.0,<8", ] dev = ["wat>=0.7.0,<0.8"] +docs = ["pyenchant", "enchant>=0.0.1,<0.0.2"] # Various config from here onward [tool.black] From 54ad831927704bb9c71e279d4a0505247ee91ffb Mon Sep 17 00:00:00 2001 From: jlnav Date: Fri, 30 Jan 2026 13:53:17 -0600 Subject: [PATCH 2/7] huh --- docs/conf.py | 1 + pixi.lock | 4 ++-- pyproject.toml | 4 ++-- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 0b7e2b3dd4..a35ff5fdf1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -101,6 +101,7 @@ class AxParameterWarning(Warning): # Ensure it's a real warning subclass "sphinxcontrib.autodoc_pydantic", "sphinx_design", "sphinx_copybutton", + "sphinx_lfs_content", ] spelling_word_list_filename = "spelling_wordlist.txt" diff --git a/pixi.lock b/pixi.lock index de36f54388..6bb2133403 100644 --- a/pixi.lock +++ b/pixi.lock @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:0c9c239a20f516658e111e78a08e9e32b4542147ac73d2100e653712fe99d171 -size 1094776 +oid sha256:29686cdf8e08ddda5445f3fefae911e9084b06a08c18bfb4bec70c3fb9e631e2 +size 1095690 diff --git a/pyproject.toml b/pyproject.toml index 66a6581c7b..384550b6e0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -214,12 +214,12 @@ extra = [ "redis>=7.1.0,<8", ] dev = ["wat>=0.7.0,<0.8"] -docs = ["pyenchant", "enchant>=0.0.1,<0.0.2"] +docs = ["pyenchant", "enchant>=0.0.1,<0.0.2", "sphinx-lfs-content>=1.1.10,<2"] # Various config from here onward [tool.black] line-length = 120 -target-version = ['py310', 'py311', 'py312', 'py313', 'py314'] +target-version = ['py310', 'py311', 'py312', 'py313'] force-exclude = ''' ( /( From 7b2939c542efa579ec9111f767e267f00bba7c4b Mon Sep 17 00:00:00 2001 From: jlnav Date: Fri, 30 Jan 2026 14:01:33 -0600 Subject: [PATCH 3/7] use the rtd-recommended git-lfs checkout step --- .readthedocs.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/.readthedocs.yml b/.readthedocs.yml index 27ae191746..8ef38e7104 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -5,6 +5,21 @@ build: tools: python: "3.10" commands: + # from https://docs.readthedocs.com/platform/stable/build-customization.html#support-git-lfs-large-file-storage + # Download and uncompress the binary + # https://git-lfs.github.com/ + - wget https://github.com/git-lfs/git-lfs/releases/download/v3.1.4/git-lfs-linux-amd64-v3.1.4.tar.gz + - tar xvfz git-lfs-linux-amd64-v3.1.4.tar.gz git-lfs + # Modify LFS config paths to point where git-lfs binary was downloaded + - git config filter.lfs.process "`pwd`/git-lfs filter-process" + - git config filter.lfs.smudge "`pwd`/git-lfs smudge -- %f" + - git config filter.lfs.clean "`pwd`/git-lfs clean -- %f" + # Make LFS available in current repository + - ./git-lfs install + # Download content from remote + - ./git-lfs fetch + # Make local files to have the real content on them + - ./git-lfs checkout - asdf plugin add pixi - asdf install pixi latest - asdf global pixi latest From 9fa6d3f611ccd5bc171c1473d2e36193844d2d18 Mon Sep 17 00:00:00 2001 From: jlnav Date: Fri, 30 Jan 2026 14:04:52 -0600 Subject: [PATCH 4/7] fix --- .readthedocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 8ef38e7104..f21ad1b1f7 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -27,7 +27,7 @@ build: - pixi run -e docs build-pdf - mkdir -p $READTHEDOCS_OUTPUT/html/ - cp -r docs/_build/html/** $READTHEDOCS_OUTPUT/html/ - - cp -r docs/_build/latex/** $READTHEDOCS_OUTPUT/pdf/ + - cp -r docs/_build/latex/** $READTHEDOCS_OUTPUT/latex/ sphinx: configuration: docs/conf.py From 01768e4a991234f634bfc0cb2b2041ce03a1966a Mon Sep 17 00:00:00 2001 From: jlnav Date: Fri, 30 Jan 2026 14:13:13 -0600 Subject: [PATCH 5/7] duh, need to make the dir --- .readthedocs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index f21ad1b1f7..7ea54a3e3f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -26,8 +26,9 @@ build: - pixi run -e docs build-docs - pixi run -e docs build-pdf - mkdir -p $READTHEDOCS_OUTPUT/html/ + - mkdir -p $READTHEDOCS_OUTPUT/pdf/ - cp -r docs/_build/html/** $READTHEDOCS_OUTPUT/html/ - - cp -r docs/_build/latex/** $READTHEDOCS_OUTPUT/latex/ + - cp -r docs/_build/latex/** $READTHEDOCS_OUTPUT/pdf/ sphinx: configuration: docs/conf.py From aa61fa3a8982f7c9453586e19eebca6ffdfc4d2e Mon Sep 17 00:00:00 2001 From: jlnav Date: Fri, 30 Jan 2026 14:29:34 -0600 Subject: [PATCH 6/7] lets see what happens if the explicit pdf step is removed - like it was in jobs from a few hours ago that succeeded --- .readthedocs.yml | 2 -- pixi.lock | 4 ++-- pyproject.toml | 3 --- 3 files changed, 2 insertions(+), 7 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 7ea54a3e3f..ff94700ab5 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -26,9 +26,7 @@ build: - pixi run -e docs build-docs - pixi run -e docs build-pdf - mkdir -p $READTHEDOCS_OUTPUT/html/ - - mkdir -p $READTHEDOCS_OUTPUT/pdf/ - cp -r docs/_build/html/** $READTHEDOCS_OUTPUT/html/ - - cp -r docs/_build/latex/** $READTHEDOCS_OUTPUT/pdf/ sphinx: configuration: docs/conf.py diff --git a/pixi.lock b/pixi.lock index 6bb2133403..d7326a9bfb 100644 --- a/pixi.lock +++ b/pixi.lock @@ -1,3 +1,3 @@ version https://git-lfs.github.com/spec/v1 -oid sha256:29686cdf8e08ddda5445f3fefae911e9084b06a08c18bfb4bec70c3fb9e631e2 -size 1095690 +oid sha256:b8d212e3316a9728e1c47bb23c7f1732d7ee17c14b82ed8d5ec41c5dd5674dab +size 1095692 diff --git a/pyproject.toml b/pyproject.toml index 384550b6e0..852acde148 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -139,9 +139,6 @@ types-pyyaml = ">=6.0.12.20250915,<7" [tool.pixi.tasks.build-docs] cmd = "cd docs && make html" -[tool.pixi.tasks.build-pdf] -cmd = "cd docs && make latex" - # Linux dependencies, only for extra tests [tool.pixi.feature.extra.target.linux-64.dependencies] scikit-build = "*" From 375a31fa4ac9e7f591ee68d050afbbcd4211e17b Mon Sep 17 00:00:00 2001 From: jlnav Date: Fri, 30 Jan 2026 14:32:52 -0600 Subject: [PATCH 7/7] forgot this - gonna squash these commits at the end --- .readthedocs.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index ff94700ab5..427711e057 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -24,7 +24,6 @@ build: - asdf install pixi latest - asdf global pixi latest - pixi run -e docs build-docs - - pixi run -e docs build-pdf - mkdir -p $READTHEDOCS_OUTPUT/html/ - cp -r docs/_build/html/** $READTHEDOCS_OUTPUT/html/