From 07a1deddabe2be6181b5e79cc5bcd2ac812ae8d3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20Ram=C3=ADrez-Mondrag=C3=B3n?= Date: Sat, 14 Feb 2026 14:01:47 -0600 Subject: [PATCH] docs: Prepare for ReadTheDocs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - https://github.com/python-backoff/backoff/issues/106 Signed-off-by: Edgar Ramírez-Mondragón --- .readthedocs.yaml | 24 ++++++++++++++++++++++++ mkdocs.yml | 3 ++- 2 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..aa9cb86 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,24 @@ +version: 2 + +build: + os: ubuntu-24.04 + tools: + python: "3.14" + jobs: + post_checkout: + - git fetch --unshallow || true + pre_create_environment: + - asdf plugin add uv + - asdf install uv latest + - asdf global uv latest + create_environment: + - uv venv "${READTHEDOCS_VIRTUALENV_PATH}" + install: + - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv pip install -r requirements/docs.requirements.txt + - UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv pip install . + build: + html: + - zensical build + post_build: + - mkdir -p $READTHEDOCS_OUTPUT/html/ + - cp --recursive site/* $READTHEDOCS_OUTPUT/html/ diff --git a/mkdocs.yml b/mkdocs.yml index 25232d8..569a891 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,5 @@ - +site_url: https://backoff.readthedocs.io/ +site_description: Python library providing function decorators for configurable backoff and retry site_name: backoff repo_url: https://github.com/python-backoff/backoff repo_name: python-backoff/backoff