Doc building to zips now working.

.settings/org.eclipse.core.resources.prefs

@@ -0,0 +1,3 @@
+#Mon Jan 09 16:45:21 GMT 2012
+eclipse.preferences.version=1
+encoding//doc/source/conf.py=utf-8

doc/build.xml

@@ -5,7 +5,17 @@
 	<target name="all" depends="clean, doc_zip" />
 	<target name="clean" depends="doc_clean" />
 
-	<target name="doc" depends="doc_clean">
+	<target name="doc_api">
+			<property name="jenkinsapi.package.path" value="${basedir}/../jenkinsapi"/>
+			<exec executable="sphinx-apidoc" >
+				        <arg value="-o"/>
+						<arg value="source"/>
+					    <arg value="${jenkinsapi.package.path}"/>
+						<arg value="-f"/>
+			</exec>
+	</target>
+
+	<target name="doc" depends="doc_clean,doc_api">
 		<mkdir dir="${docs.html.dir}" />
 		<exec executable="sphinx-build" >
 			        <arg value="-b"/>

doc/source/.gitignore

@@ -0,0 +1,4 @@
+/jenkinsapi.utils.rst
+/jenkinsapi.command_line.rst
+/jenkinsapi.rst
+/modules.rst

doc/source/index.rst

@@ -1,20 +1,51 @@
-..  JenkinsAPI documentation master file, created by
-   sphinx-quickstart on Mon Jan 09 16:35:17 2012.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to the JenkinsAPI project documentation
-===============================================
-
-Contents:
-
-.. toctree:: 
-   :maxdepth: 2
-
-   api
-   artifact
-   build
-   urlopener
+JenkinsAPI
+==========
+
+Jenkins is the market leading continuous integration system, originally created by Kohsuke Kawaguchi. This API makes Jenkins even easier to use by providing an easy to use conventional python interface.
+
+Jenkins (and It's predecessor Hudson) are fantastic projects - but they are somewhat Java-centric. Thankfully the designers have provided an excellent and complete REST interface. This library wraps up that interface as more conventional python objects in order to make most Jenkins oriented tasks simpler.
+
+This library can help you:
+
+ * Query the test-results of a completed build
+ * Get a objects representing the latest builds of a job
+ * Search for artifacts by simple criteria
+ * Block until jobs are complete
+ * Install artifacts to custom-specified directory structures
+ * Username/password auth support for jenkins instances with auth turned on
+ * Search for builds by subversion revision
+ * Add, remove and query jenkins slaves
+
+Installation
+============
+
+Egg-files for this project are hosted on PyPi. Most Python users should be able to use pip or distribute to automatically install this project.
+
+Most users can do the following:
+
+    easy_install jenkinsapi
+
+If you'd like to install in multi-version mode:
+
+    easy_install -m jenkinsapi
+
+Project Authors
+===============
+
+ * Salim Fadhley (sal@stodge.org) 
+ * Ramon van Alteren (ramon@vanalteren.nl) 
+ * Ruslan Lutsenko (ruslan.lutcenko@gmail.com) 
+
+Current code lives on github: https://github.com/salimfadhley/jenkinsapi
+
+Package Contents
+================
+
+.. toctree::
+   jenkinsapi
+   jenkinsapi.command_line
+   jenkinsapi.utils
+   modules
 
 Indices and tables
 ==================

setup.py

@@ -6,7 +6,7 @@
       version=VERSION,
       author=PROJECT_AUTHORS,
       author_email=PROJECT_EMAILS,
-      packages=find_packages('.'),
+      packages=["jenkinsapi",], # Disabled use fo find-packages to exclude examples & tests
       zip_safe=True,
       include_package_data = False,
       entry_points = GLOBAL_ENTRY_POINTS,