diff --git a/.readthedocs.yaml b/.readthedocs.yaml deleted file mode 100644 index b26b2e09..00000000 --- a/.readthedocs.yaml +++ /dev/null @@ -1,20 +0,0 @@ -version: 2 - -build: - os: ubuntu-24.04 - tools: - python: "3.14" - apt_packages: - - graphviz - - plantuml - -sphinx: - configuration: doc/source/conf.py - fail_on_warning: true - -python: - install: - - method: uv - command: sync - groups: - - doc diff --git a/.readthedocs.yml b/.readthedocs.yml index c2c1c68b..4ffc2bff 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -2,30 +2,25 @@ # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details -# Required version: 2 build: - os: ubuntu-22.04 + os: ubuntu-24.04 tools: - python: "3.12" + python: "3.14" apt_packages: - graphviz - jobs: - post_create_environment: - - python -m pip install uv==0.8.4 - - uv export --format requirements-txt --group doc --output-file requirements-doc.txt + - plantuml -# Build documentation in the docs/ directory with Sphinx sphinx: configuration: doc/source/conf.py + fail_on_warning: true -# Optionally build your docs in additional formats such as PDF and ePub formats: all -# Optionally set the version of Python and requirements required to build your docs python: install: - - requirements: requirements-doc.txt - - method: pip - path: . + - method: uv + command: sync + groups: + - doc diff --git a/doc/source/conf.py b/doc/source/conf.py index 7c8a742c..29af0074 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -57,6 +57,11 @@ 'sphinxcontrib.plantuml', ] +# graphviz emits .png.map imagemap files that the epub builder cannot classify; +# epub does not support imagemaps, so silence the un-actionable mimetype warning +# (otherwise fail_on_warning breaks the epub build from `formats: all`). +suppress_warnings = ['epub.unknown_project_files'] + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']