170e878d2a
Sphinx: * Build dir is now named `build` and the files are under `source`. * MakeFile learned texinfo, info and gettext targets * include __init__ documentation (autoclass_content) * keep file ordering for methods (autodoc_member_order) * comment out html_static_path to get rid of a warning Doc: * Index is now... an index! Takes advantage of :glob: to automatically create a complete table of content. * Creates API reference which list the documentation directly from the jenkins/__init__.py file. That will avoid the documentation duplication and some out of sync documentation. * insert the module in the path to document it * the example were both in index.rst and __init__.py create a new section with example.rst. That can be later be improved with some typical use cases. * A couple documentation update to some methods. The inline documentation was out of sync though the index.rst got updated.
23 lines
642 B
ReStructuredText
23 lines
642 B
ReStructuredText
Example usage
|
|
=============
|
|
|
|
Example usage::
|
|
|
|
j = jenkins.Jenkins('http://your_url_here', 'username', 'password')
|
|
j.get_jobs()
|
|
j.create_job('empty', jenkins.EMPTY_CONFIG_XML)
|
|
j.disable_job('empty')
|
|
j.copy_job('empty', 'empty_copy')
|
|
j.enable_job('empty_copy')
|
|
j.reconfig_job('empty_copy', jenkins.RECONFIG_XML)
|
|
|
|
j.delete_job('empty')
|
|
j.delete_job('empty_copy')
|
|
|
|
# build a parameterized job
|
|
j.build_job('api-test', {'param1': 'test value 1', 'param2': 'test value 2'})
|
|
build_info = j.get_build_info('build_name', next_build_number)
|
|
print(build_info)
|
|
|
|
Look at the :doc:`api` for more details.
|