Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 22 additions & 8 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 1 addition & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
8 changes: 0 additions & 8 deletions docs/requirements.txt

This file was deleted.

4 changes: 2 additions & 2 deletions pixi.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 5 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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 = "*"
Expand Down Expand Up @@ -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 = '''
(
/(
Expand Down