Skip to content

Commit

Permalink
update doc (#101)
Browse files Browse the repository at this point in the history
  • Loading branch information
joelee2012 authored Jan 26, 2024
1 parent 0c9bddf commit d2c64e3
Show file tree
Hide file tree
Showing 2 changed files with 0 additions and 11 deletions.
3 changes: 0 additions & 3 deletions api4jenkins/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
8 changes: 0 additions & 8 deletions docs/source/user/example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>`_
Expand Down

0 comments on commit d2c64e3

Please sign in to comment.