diff --git a/.cspell.json b/.cspell.json index 17475a4e..24f4d9f1 100644 --- a/.cspell.json +++ b/.cspell.json @@ -23,6 +23,7 @@ ".gitpod.*", ".pre-commit-config.yaml", ".prettierignore", + ".readthedocs.yml", ".vscode/*", ".vscode/.gitignore", "codecov.yml", diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index 9615d832..8078bccc 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -32,6 +32,8 @@ replacers: sort-direction: ascending template: | + _See all documentation for this version [here](https://ampform-dpd.rtfd.io/en/$NEXT_PATCH_VERSION)._ + $CHANGES _The full changelog as commits can be found [here](https://github.com/ComPWA/ampform-dpd/compare/$PREVIOUS_TAG...$NEXT_PATCH_VERSION)._ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0361bfbb..35af869f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -41,11 +41,12 @@ repos: metadata.vscode - repo: https://github.com/ComPWA/policy - rev: 0.3.6 + rev: 0.3.8 hooks: - id: check-dev-files args: - --doc-apt-packages=graphviz + - --github-pages - --no-prettierrc - --pin-requirements=bimonthly - --repo-name=ampform-dpd diff --git a/.readthedocs.yml b/.readthedocs.yml new file mode 100644 index 00000000..eebab3b2 --- /dev/null +++ b/.readthedocs.yml @@ -0,0 +1,21 @@ +version: 2 + +sphinx: + builder: dirhtml + configuration: docs/conf.py + fail_on_warning: true + +formats: + - htmlzip + +build: + os: ubuntu-22.04 + tools: + python: "3.9" + apt_packages: + - graphviz + jobs: + post_install: + - curl -LsSf https://astral.sh/uv/install.sh | sh + - |- + /home/docs/.cargo/bin/uv pip install --system -c .constraints/py3.9.txt -e .[doc]