From b6e04003a787d201827c9e481a0749e5e264d6dd Mon Sep 17 00:00:00 2001 From: masklinn Date: Mon, 25 Nov 2024 17:23:30 +0100 Subject: [PATCH] Add configuration file for RTFD --- .readthedocs.yaml | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..5fb8a1c --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,34 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +version: 2 + +# needed for uap-core to get initialised properly +submodules: + include: all + +build: + os: ubuntu-24.04 + tools: + python: "3.12" + jobs: + post_checkout: + # rtfd doesn't retrieve tags by default, but we need them for `git + # describe` in order to build the parser builtins + # FIXME: remove once upb is published and can be installed from pypi) + - git fetch --unshallow --tags || true + +python: + install: + - method: pip + path: ./ua-parser-builtins + - method: pip + path: . + extra_requirements: + - yaml + - regex + - re2 + +sphinx: + configuration: doc/conf.py + fail_on_warning: true