Skip to content
Closed
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
46 changes: 9 additions & 37 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,50 +2,22 @@ version: 2

formats:
- htmlzip
# - pdf

sphinx:
configuration: docs/conf.py

build:
os: ubuntu-24.04
os: ubuntu-26.04
tools:
python: "3.14"
apt_packages:
- cmake
- graphviz
- inkscape
jobs:
post_checkout:
# Skip docs build if the commit message contains "skip ci"
- (git --no-pager log --pretty="tformat:%s -- %b" -1 | grep -viq "skip ci") || exit 183
# Skip docs build if there are no changes related to docs
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- bindings/ include/ docs/ python/ .github/SUPPORT.md .readthedocs.yaml;
then
exit 183;
fi
# Unshallow the git clone and fetch tags to get proper version information
- git fetch --unshallow --tags
pre_build:
# Set up uv
- asdf plugin add uv
- asdf install uv latest
- asdf global uv latest
- wget https://github.com/Z3Prover/z3/releases/download/z3-4.13.4/z3-4.13.4-x64-glibc-2.35.zip
- unzip z3-4.13.4-x64-glibc-2.35.zip -d ~/
# Set up build-time dependencies
- uv sync --only-group build --only-group docs
# Install CMake because the default version on Ubuntu 24.04 is too old
- uv pip install cmake
build:
html:
- 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
htmlzip:
- 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
- mkdir -p $READTHEDOCS_OUTPUT/htmlzip
- zip -r $READTHEDOCS_OUTPUT/htmlzip/html.zip docs/_build/dirhtml/*
# pdf:
# - 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
# - cd docs/_build/latex && latexmk -pdf -f -dvi- -ps- -interaction=nonstopmode -jobname=$READTHEDOCS_PROJECT
# - mkdir -p $READTHEDOCS_OUTPUT/pdf
# - cp docs/_build/latex/$READTHEDOCS_PROJECT.pdf $READTHEDOCS_OUTPUT/pdf/$READTHEDOCS_PROJECT.pdf

python:
install:
- method: uv
command: sync
groups:
- docs
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,7 @@ docs = [
"sphinxext-opengraph>=0.13.0",
"walkerlayout>=1.0.2",
"qiskit[qasm3-import,visualization]>=1.0.0",
"z3-solver>=4.16.0"
]
test = [
"pytest>=9.0.1",
Expand Down
19 changes: 18 additions & 1 deletion uv.lock

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

Loading