Doc building to zips now working.

diff --git a/.settings/org.eclipse.core.resources.prefs b/.settings/org.eclipse.core.resources.prefs
new file mode 100644 (file)
index 0000000..107568d
--- /dev/null
+++ b/.settings/org.eclipse.core.resources.prefs
@@ -0,0 +1,3 @@
+#Mon Jan 09 16:45:21 GMT 2012\r
+eclipse.preferences.version=1\r
+encoding//doc/source/conf.py=utf-8\r

diff --git a/doc/build.xml b/doc/build.xml
index 6d6cf68642e7a7111cf59ea7aa6ed3ce28636af5..704e17d59364b58d5f7121728269e6a5614441fe 100644 (file)
--- a/doc/build.xml
+++ b/doc/build.xml
@@ -5,7 +5,17 @@
        <target name="all" depends="clean, doc_zip" />\r
        <target name="clean" depends="doc_clean" />\r
        \r
-       <target name="doc" depends="doc_clean">\r
+       <target name="doc_api">\r
+                       <property name="jenkinsapi.package.path" value="${basedir}/../jenkinsapi"/>\r
+                       <exec executable="sphinx-apidoc" >\r
+                                       <arg value="-o"/>\r
+                                               <arg value="source"/>\r
+                                           <arg value="${jenkinsapi.package.path}"/>\r
+                                               <arg value="-f"/>\r
+                       </exec>\r
+       </target>\r
+       \r
+       <target name="doc" depends="doc_clean,doc_api">\r
                <mkdir dir="${docs.html.dir}" />\r
                <exec executable="sphinx-build" >\r
                                <arg value="-b"/>\r

diff --git a/doc/source/.gitignore b/doc/source/.gitignore
new file mode 100644 (file)
index 0000000..f1afd02
--- /dev/null
+++ b/doc/source/.gitignore
@@ -0,0 +1,4 @@
+/jenkinsapi.utils.rst
+/jenkinsapi.command_line.rst
+/jenkinsapi.rst
+/modules.rst

diff --git a/doc/source/index.rst b/doc/source/index.rst
index 5352289f9ea0e83074e82f587f334c80e309275a..6de0b26b113f5933483387bb28d0f351ee4a91f2 100644 (file)
--- a/doc/source/index.rst
+++ b/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
 ==================

diff --git a/jenkinsapi_tests/__init__.py b/jenkinsapi_tests/__init__.py
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/setup.py b/setup.py
index 6fccfcef362af3003823667fd429b2053825a1d5..c5f22b0c2c8842f0ffa186ea9f55cee13c14645c 100644 (file)
--- a/setup.py
+++ b/setup.py
@@ -6,7 +6,7 @@ setup(name=PROJECT_NAME.lower(),
       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,