docs: improve branding, design & fix warnings (#191)

* docs: fix warnings from sphinx build

* docs: improve branding + design

- Current header has a weird color contrast -> making bg gray and fixing the white text to a good color
- Adding a favicon

Author: apricote

docs/_static/custom.css

@@ -0,0 +1,4 @@
+.wy-side-nav-search > div.version {
+    /* Version in Nav is off-white by default, but we restyle the header to have an off-white bg */
+    color: #404040;
+}

docs/_static/favicon.png

@@ -1,5 +1,5 @@
 PlacementGroupsClient
-==================
+=====================
 
 
 .. autoclass:: hcloud.placement_groups.client.PlacementGroupsClient

docs/api.clients.placement_groups.rst

@@ -64,7 +64,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -88,11 +88,15 @@
 #
 html_theme = "sphinx_rtd_theme"
 html_logo = "_static/logo-hetzner-online.svg"
+html_favicon = "_static/favicon.png"
 # Theme options are theme-specific and customize the look and feel of a
 # theme further.  For a list of options available for each theme, see the
 # documentation.
 #
-html_theme_options = {"logo_only": True}
+html_theme_options = {"logo_only": True, "style_nav_header_background": "#EFEFEF"}
+html_css_files = [
+    "custom.css",
+]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/conf.py

@@ -24,7 +24,7 @@ you through the process.
 
 
 Via conda (Third-Party)
----------
+-----------------------
 
 Hetzner Cloud Python is also available as a ``conda``-package via `conda-forge`. This package is not maintained by Hetzner Cloud and might be outdated._:
 

docs/installation.rst

@@ -142,7 +142,7 @@ def get_list(
         return self._add_meta_to_result(certificates, response)
 
     def get_all(self, name=None, label_selector=None):
-        # type: (Optional[str]) -> List[BoundCertificate]
+        # type: (Optional[str], Optional[str]) -> List[BoundCertificate]
         """Get all certificates
 
         :param name: str (optional)
@@ -166,7 +166,7 @@ def get_by_name(self, name):
         return super(CertificatesClient, self).get_by_name(name)
 
     def create(self, name, certificate, private_key, labels=None):
-        # type: (str, str, Optional[Dict[str, str]]) -> BoundCertificate
+        # type: (str, str, str, Optional[Dict[str, str]]) -> BoundCertificate
         """Creates a new Certificate with the given name, certificate and private_key. This methods allows only creating
            custom uploaded certificates. If you want to create a managed certificate use :func:`~hcloud.certificates.client.CertificatesClient.create_managed`
 

hcloud/certificates/client.py

@@ -75,7 +75,7 @@ def get_actions_list(self, status=None, sort=None, page=None, per_page=None):
         return self._client.get_actions_list(self, status, sort, page, per_page)
 
     def get_actions(self, status=None, sort=None):
-        # type: (Optional[List[str]]) -> List[BoundAction]
+        # type: (Optional[List[str]], Optional[List[str]]) -> List[BoundAction]
         """Returns all action objects for a Firewall.
 
         :param status: List[str] (optional)

hcloud/firewalls/client.py

@@ -43,7 +43,7 @@ def get_actions_list(self, status=None, sort=None, page=None, per_page=None):
         return self._client.get_actions_list(self, status, sort, page, per_page)
 
     def get_actions(self, status=None, sort=None):
-        # type: (Optional[List[str]]) -> List[BoundAction]
+        # type: (Optional[List[str]], Optional[List[str]]) -> List[BoundAction]
         """Returns all action objects for a Floating IP.
 
         :param status: List[str] (optional)
@@ -91,7 +91,7 @@ def assign(self, server):
         # type: (Server) -> BoundAction
         """Assigns a Floating IP to a server.
 
-        :param server: :class:`BoundServer <hcloud.servers.client.BoundServer>` or  :class:`Server <hcloud.servers.domain.Server>`
+        :param server: :class:`BoundServer <hcloud.servers.client.BoundServer>` or :class:`Server <hcloud.servers.domain.Server>`
                Server the Floating IP shall be assigned to
         :return: :class:`BoundAction <hcloud.actions.client.BoundAction>`
         """

hcloud/floating_ips/client.py

@@ -55,7 +55,7 @@ def get_actions(self, sort=None, status=None):
         return self._client.get_actions(self, status=status, sort=sort)
 
     def update(self, description=None, type=None, labels=None):
-        # type: (Optional[str], Optional[Dict[str, str]]) -> BoundImage
+        # type: (Optional[str], Optional[str], Optional[Dict[str, str]]) -> BoundImage
         """Updates the Image. You may change the description, convert a Backup image to a Snapshot Image or change the image labels.
 
         :param description: str (optional)

hcloud/images/client.py

@@ -10,7 +10,7 @@ class ServerTypesClient(ClientEntityBase, GetEntityByNameMixin):
     results_list_attribute_name = "server_types"
 
     def get_by_id(self, id):
-        # type: (int) -> server_types.client.BoundServerType
+        # type: (int) -> BoundServerType
         """Returns a specific Server Type.
 
         :param id: int