From e61300eda7f0ba15e0a91cce3e4b8f7542ed42c8 Mon Sep 17 00:00:00 2001 From: Jonas L Date: Thu, 17 Aug 2023 14:17:53 +0200 Subject: [PATCH] docs: fail on warning (#289) * docs: fail on warning Make sure to catch warnings during the docs build process. * docs: fix docstrings warnings --- .readthedocs.yaml | 1 + hcloud/actions/client.py | 12 ++++++------ 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7d43aa6..dcda10d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,6 +14,7 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/conf.py + fail_on_warning: true # Optionally build your docs in additional formats such as PDF and ePub formats: [pdf, epub] diff --git a/hcloud/actions/client.py b/hcloud/actions/client.py index 63e1d88..2433bcd 100644 --- a/hcloud/actions/client.py +++ b/hcloud/actions/client.py @@ -129,10 +129,10 @@ def get_list( ) -> ActionsPageResult: """ .. deprecated:: 1.28 - Use :func:`client..actions.get_list` instead, - e.g. using :attr:`hcloud.certificates.client.CertificatesClient.actions`. + Use :func:`client..actions.get_list` instead, + e.g. using :attr:`hcloud.certificates.client.CertificatesClient.actions`. - `Starting 1 October 2023, it will no longer be available. `_ + `Starting 1 October 2023, it will no longer be available. `_ """ warnings.warn( "The 'client.actions.get_list' method is deprecated, please use the " @@ -150,10 +150,10 @@ def get_all( ) -> list[BoundAction]: """ .. deprecated:: 1.28 - Use :func:`client..actions.get_all` instead, - e.g. using :attr:`hcloud.certificates.client.CertificatesClient.actions`. + Use :func:`client..actions.get_all` instead, + e.g. using :attr:`hcloud.certificates.client.CertificatesClient.actions`. - `Starting 1 October 2023, it will no longer be available. `_ + `Starting 1 October 2023, it will no longer be available. `_ """ warnings.warn( "The 'client.actions.get_all' method is deprecated, please use the "