jjb/python-jenkins
Code Issues Proposed changes
python-jenkins/doc/source/install.rst
Antoine Musso 170e878d2a overhaul the sphinx documentation 
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.
2013-04-13 23:59:59 +02:00

475 B
Raw Blame History

title

Installing

Installing

The module is known to pip and Debian based distribution as python-jenkins.

pip:

pip install python-jenkins

easy_install:

easy_install python-jenkins

The module has been packaged since Ubuntu Oneiric (11.10):

apt-get install python-jenkins

For developpement purpose you can get a fake module installed on your system that will point to your working copy. Simply use:

python setup.py develop