Merge pull request #1667 from Libensemble/docs/ax_status

deps in place to fix ax issues (at least locally), experimenting with…

Author: jlnav

.readthedocs.yml

@@ -4,17 +4,31 @@ build:
   os: "ubuntu-22.04"
   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
+    - pixi run -e docs build-docs
+    - mkdir -p $READTHEDOCS_OUTPUT/html/
+    - cp -r docs/_build/html/** $READTHEDOCS_OUTPUT/html/
 
 sphinx:
     configuration: docs/conf.py
 
 formats:
   - pdf
-
-python:
-    install:
-      - requirements: docs/requirements.txt
-      - method: pip
-        path: .
-        extra_requirements:
-         - docs

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"

docs/requirements.txt

@@ -136,6 +136,9 @@ 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"
+
 # Linux dependencies, only for extra tests
 [tool.pixi.feature.extra.target.linux-64.dependencies]
 scikit-build = "*"
@@ -208,11 +211,12 @@ extra = [
   "redis>=7.1.0,<8",
 ]
 dev = ["wat>=0.7.0,<0.8"]
+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 = '''
 (
   /(