Skip to content

Commit

Permalink
MAINT: add Read the Docs configuration (#122)
Browse files Browse the repository at this point in the history
  • Loading branch information
redeboer authored Apr 29, 2024
1 parent 6bdf06b commit 68aaa34
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 1 deletion.
1 change: 1 addition & 0 deletions .cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
".gitpod.*",
".pre-commit-config.yaml",
".prettierignore",
".readthedocs.yml",
".vscode/*",
".vscode/.gitignore",
"codecov.yml",
Expand Down
2 changes: 2 additions & 0 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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)._
3 changes: 2 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
21 changes: 21 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -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]

0 comments on commit 68aaa34

Please sign in to comment.