Skip to content

Commit 1500fbc

Browse files
authored
Fix documentation generation issues (#128)
Signed-off-by: Lukas Kämmerling <lukas.kaemmerling@hetzner-cloud.de>
1 parent fb30f0b commit 1500fbc

6 files changed

Lines changed: 13 additions & 15 deletions

File tree

docs/api.clients.certificates.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ CertificateClient
22
==================
33

44

5-
.. autoclass:: hcloud.certificates.client.CertificateClient
5+
.. autoclass:: hcloud.certificates.client.CertificatesClient
66
:members:
77

88
.. autoclass:: hcloud.certificates.client.BoundCertificate

docs/api.clients.load_balancer_types.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
LoadBalancerTypesClient
2-
==================
2+
========================
33

44

55
.. autoclass:: hcloud.load_balancer_types.client.LoadBalancerTypesClient

docs/api.clients.load_balancers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ LoadBalancerClient
2020
.. autoclass:: hcloud.load_balancers.domain.LoadBalancerHealthCheck
2121
:members:
2222

23-
.. autoclass:: hcloud.load_balancers.domain.LoadBalancerHealthCheckHttp
23+
.. autoclass:: hcloud.load_balancers.domain.LoadBalancerHealtCheckHttp
2424
:members:
2525

2626
.. autoclass:: hcloud.load_balancers.domain.LoadBalancerTarget

docs/conf.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,3 @@
160160
]
161161

162162
source_suffix = ['.rst']
163-
164-
165-
def setup(app):
166-
app.add_javascript('js/open_links_in_new_tab.js')

hcloud/load_balancers/client.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ def get_by_id(self, id):
268268
"""Get a specific Load Balancer
269269
270270
:param id: int
271-
:return: :class:`BoundLoadBalancer <hcloud.load_balancers.client.BoundLoadBalancer>
271+
:return: :class:`BoundLoadBalancer <hcloud.load_balancers.client.BoundLoadBalancer>`
272272
"""
273273
response = self._client.request(
274274
url="/load_balancers/{load_balancer_id}".format(load_balancer_id=id), method="GET"

hcloud/load_balancers/domain.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,7 @@ def __init__(self, domain=None, path=None, response=None, status_codes=None, tls
193193

194194
class LoadBalancerTarget(BaseDomain):
195195
"""LoadBalancerTarget Domain
196+
196197
:param type: str
197198
Type of the resource, can be server or label_selector
198199
:param server: Server
@@ -215,8 +216,8 @@ def __init__(self, type=None, server=None, label_selector=None, ip=None, use_pri
215216

216217
class LoadBalancerTargetLabelSelector(BaseDomain):
217218
"""LoadBalancerTargetLabelSelector Domain
218-
:param selector: str
219-
Target label selector
219+
220+
:param selector: str Target label selector
220221
"""
221222

222223
def __init__(self, selector=None):
@@ -225,8 +226,8 @@ def __init__(self, selector=None):
225226

226227
class LoadBalancerTargetIP(BaseDomain):
227228
"""LoadBalancerTargetIP Domain
228-
:param ip: str
229-
Target IP
229+
230+
:param ip: str Target IP
230231
"""
231232

232233
def __init__(self, ip=None):
@@ -235,9 +236,10 @@ def __init__(self, ip=None):
235236

236237
class LoadBalancerAlgorithm(BaseDomain):
237238
"""LoadBalancerAlgorithm Domain
238-
:param type: str
239-
Algorithm of the Load Balancer. Choices: round_robin, least_connections
240-
"""
239+
240+
:param type: str
241+
Algorithm of the Load Balancer. Choices: round_robin, least_connections
242+
"""
241243

242244
def __init__(self, type=None):
243245
self.type = type

0 commit comments

Comments
 (0)