Skip to content

Commit adbf5ae

Browse files
committed
🔧 Simplify .readthedocs.yaml
1 parent b9447c5 commit adbf5ae

1 file changed

Lines changed: 8 additions & 36 deletions

File tree

.readthedocs.yaml

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ version: 2
22

33
formats:
44
- htmlzip
5-
# - pdf
65

76
sphinx:
87
configuration: docs/conf.py
@@ -12,40 +11,13 @@ build:
1211
tools:
1312
python: "3.14"
1413
apt_packages:
14+
- cmake
1515
- graphviz
1616
- inkscape
17-
jobs:
18-
post_checkout:
19-
# Skip docs build if the commit message contains "skip ci"
20-
- (git --no-pager log --pretty="tformat:%s -- %b" -1 | grep -viq "skip ci") || exit 183
21-
# Skip docs build if there are no changes related to docs
22-
- |
23-
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- bindings/ include/ docs/ python/ .github/SUPPORT.md .readthedocs.yaml;
24-
then
25-
exit 183;
26-
fi
27-
# Unshallow the git clone and fetch tags to get proper version information
28-
- git fetch --unshallow --tags
29-
pre_build:
30-
# Set up uv
31-
- asdf plugin add uv
32-
- asdf install uv latest
33-
- asdf global uv latest
34-
- wget https://github.com/Z3Prover/z3/releases/download/z3-4.13.4/z3-4.13.4-x64-glibc-2.35.zip
35-
- unzip z3-4.13.4-x64-glibc-2.35.zip -d ~/
36-
# Set up build-time dependencies
37-
- uv sync --only-group build --only-group docs
38-
# Install CMake because the default version on Ubuntu 24.04 is too old
39-
- uv pip install cmake
40-
build:
41-
html:
42-
- Z3_ROOT=~/z3-4.13.4-x64-glibc-2.35 uv run --frozen --no-dev --no-build-isolation-package mqt-qmap -m sphinx -T -b html -d docs/_build/doctrees -D language=en docs $READTHEDOCS_OUTPUT/html
43-
htmlzip:
44-
- Z3_ROOT=~/z3-4.13.4-x64-glibc-2.35 uv run --frozen --no-dev --no-build-isolation-package mqt-qmap -m sphinx -T -b dirhtml -d docs/_build/doctrees -D language=en docs docs/_build/dirhtml
45-
- mkdir -p $READTHEDOCS_OUTPUT/htmlzip
46-
- zip -r $READTHEDOCS_OUTPUT/htmlzip/html.zip docs/_build/dirhtml/*
47-
# pdf:
48-
# - Z3_ROOT=~/z3-4.13.4-x64-glibc-2.35 uv run --frozen --no-dev --no-build-isolation-package mqt-qmap -m sphinx -T -b latex -d docs/_build/doctrees -D language=en docs docs/_build/latex
49-
# - cd docs/_build/latex && latexmk -pdf -f -dvi- -ps- -interaction=nonstopmode -jobname=$READTHEDOCS_PROJECT
50-
# - mkdir -p $READTHEDOCS_OUTPUT/pdf
51-
# - cp docs/_build/latex/$READTHEDOCS_PROJECT.pdf $READTHEDOCS_OUTPUT/pdf/$READTHEDOCS_PROJECT.pdf
17+
18+
python:
19+
install:
20+
- method: uv
21+
command: sync
22+
groups:
23+
- docs

0 commit comments

Comments
 (0)