From 216d0fa4120cd2b778860b29695433d2e95ff451 Mon Sep 17 00:00:00 2001 From: Martin Eigenmann Date: Mon, 9 Sep 2024 12:47:57 +0200 Subject: [PATCH 1/2] docs: add read-the-docs config --- .readthedocs.yaml | 9 +++++++++ docs/conf.py | 6 +++--- 2 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..c54fd88 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,9 @@ +version: 2 + +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +sphinx: + configuration: docs/conf.py diff --git a/docs/conf.py b/docs/conf.py index 8977b72..5538316 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,11 +19,11 @@ # -- Project information ----------------------------------------------------- project = "iCalEvents" -copyright = "2021, Thomas Irgang" -author = "Thomas Irgang" +copyright = "2024, jazzband" +author = "Martin Eigenmann" # The full version, including alpha/beta/rc tags -release = "0.1.27" +release = "0.1.28" # -- General configuration --------------------------------------------------- From 2ee965d6a3234e3861fb83bfbc67cc303004cfde Mon Sep 17 00:00:00 2001 From: Martin Eigenmann Date: Mon, 9 Sep 2024 12:58:32 +0200 Subject: [PATCH 2/2] docs: adds dependencies for read the docs --- .readthedocs.yaml | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c54fd88..4c79121 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,6 +4,16 @@ build: os: ubuntu-22.04 tools: python: "3.12" - + jobs: + post_create_environment: + # Install poetry + # https://python-poetry.org/docs/#installing-manually + - pip install poetry + post_install: + # Install dependencies with 'docs' dependency group + # https://python-poetry.org/docs/managing-dependencies/#dependency-groups + # VIRTUAL_ENV needs to be set manually for now. + # See https://github.com/readthedocs/readthedocs.org/pull/11152/ + - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs sphinx: configuration: docs/conf.py