From d2c64e3b2257c87a8011f6021d2797aba7c1baab Mon Sep 17 00:00:00 2001 From: Joe Lee <lj_2005@163.com> Date: Fri, 26 Jan 2024 16:23:43 +0800 Subject: [PATCH] update doc (#101) --- api4jenkins/__init__.py | 3 --- docs/source/user/example.rst | 8 -------- 2 files changed, 11 deletions(-) diff --git a/api4jenkins/__init__.py b/api4jenkins/__init__.py index d837811..79f4336 100644 --- a/api4jenkins/__init__.py +++ b/api4jenkins/__init__.py @@ -29,9 +29,6 @@ class Jenkins(Item, UrlMixIn): :param url: URL of Jenkins server, ``str`` :param auth: (optional) Auth ``tuple`` to enable Basic/Digest/Custom HTTP Auth. - :param token: (optional) Boolean, Create user token when initialize instance and - revoke token once instance is destroied. useful when LDAP server refuse - username and password used too much often. Defaults to ``False``. :param \*\*kwargs: other kwargs are same as `httpx.Client <https://www.python-httpx.org/api/#client>`_ Usage:: diff --git a/docs/source/user/example.rst b/docs/source/user/example.rst index 970b76c..f11f772 100644 --- a/docs/source/user/example.rst +++ b/docs/source/user/example.rst @@ -13,14 +13,6 @@ The first step is to initialize Jenkins object, it is very simple, just set >>> print(j) <Jenkins: http://127.0.0.1:8080/> -if Jenkins integrated with LDAP server, sometimes LDAP server will refuse to -connect if access with username and password too much often, in this case, -you can set **max_retries(default is 1)** to retry or enable dynamic api token -when initialize Jenkins which will create new api token and revoke token when -object is destoried by garbage collection. - - >>> j = Jenkins('http://127.0.0.1:8080/', auth=('username', 'password'), token=True) - .. note:: Any parameter supported by `httpx.Client <https://www.python-httpx.org/api/#client>`_