docs: fail on warning (#289)

* docs: fail on warning

Make sure to catch warnings during the docs build process.

* docs: fix docstrings warnings

Author: jooola

.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]

hcloud/actions/client.py

@@ -129,10 +129,10 @@ def get_list(
     ) -> ActionsPageResult:
         """
         .. deprecated:: 1.28
-        Use :func:`client.<resource>.actions.get_list` instead,
-        e.g. using :attr:`hcloud.certificates.client.CertificatesClient.actions`.
+            Use :func:`client.<resource>.actions.get_list` instead,
+            e.g. using :attr:`hcloud.certificates.client.CertificatesClient.actions`.
 
-        `Starting 1 October 2023, it will no longer be available. <https://docs.hetzner.cloud/changelog#2023-07-20-actions-list-endpoint-is-deprecated>`_
+            `Starting 1 October 2023, it will no longer be available. <https://docs.hetzner.cloud/changelog#2023-07-20-actions-list-endpoint-is-deprecated>`_
         """
         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.<resource>.actions.get_all` instead,
-        e.g. using :attr:`hcloud.certificates.client.CertificatesClient.actions`.
+            Use :func:`client.<resource>.actions.get_all` instead,
+            e.g. using :attr:`hcloud.certificates.client.CertificatesClient.actions`.
 
-        `Starting 1 October 2023, it will no longer be available. <https://docs.hetzner.cloud/changelog#2023-07-20-actions-list-endpoint-is-deprecated>`_
+            `Starting 1 October 2023, it will no longer be available. <https://docs.hetzner.cloud/changelog#2023-07-20-actions-list-endpoint-is-deprecated>`_
         """
         warnings.warn(
             "The 'client.actions.get_all' method is deprecated, please use the "