From 28f569f97266b90834dad1e10713b9b9023a9e4d Mon Sep 17 00:00:00 2001 From: Salim Fadhley Date: Mon, 9 Jan 2012 15:15:04 +0000 Subject: [PATCH] Interim commit - adding support for zipping docs. --- doc/build.properties | 1 + doc/build.xml | 10 +++++++++- doc/epydoc.cfg | 19 +++++++++++++++++++ doc/run_epydoc.py | 7 +++++++ 4 files changed, 36 insertions(+), 1 deletion(-) create mode 100644 doc/build.properties diff --git a/doc/build.properties b/doc/build.properties new file mode 100644 index 0000000..2cb145e --- /dev/null +++ b/doc/build.properties @@ -0,0 +1 @@ +docs.zipfile.filename=docs_html.zip \ No newline at end of file diff --git a/doc/build.xml b/doc/build.xml index 57e4896..c4073f7 100644 --- a/doc/build.xml +++ b/doc/build.xml @@ -1,8 +1,8 @@ - + @@ -13,6 +13,7 @@ + @@ -20,6 +21,13 @@ + + + + + + + diff --git a/doc/epydoc.cfg b/doc/epydoc.cfg index e69de29..3c67ef5 100644 --- a/doc/epydoc.cfg +++ b/doc/epydoc.cfg @@ -0,0 +1,19 @@ +[epydoc] # Epydoc section marker (required by ConfigParser) + +# Information about the project. +name: JenkinsAPI +url: https://github.com/salimfadhley/jenkinsapi + +# The list of modules to document. Modules can be named using +# dotted names, module filenames, or package directory names. +# This option may be repeated. +modules: jenkinsapi + +# Write html output to the directory "apidocs" +output: html +target: doc/html/ + +# Include all automatically generated graphs. These graphs are +# generated using Graphviz dot. +#graph: all +#dotpath: /usr/local/bin/dot \ No newline at end of file diff --git a/doc/run_epydoc.py b/doc/run_epydoc.py index 96e2f63..aeb8556 100644 --- a/doc/run_epydoc.py +++ b/doc/run_epydoc.py @@ -1,3 +1,5 @@ +import os, sys + try: from epydoc.cli import cli except ImportError: @@ -5,4 +7,9 @@ except ImportError: require("epydoc>=3.0.1") from epydoc.cli import cli +DOC_DIR, _ = os.path.split( os.path.abspath( __file__ ) ) +PROJECT_DIR, _ = os.path.split( DOC_DIR ) + +sys.path.insert( 0, PROJECT_DIR ) + cli() \ No newline at end of file -- 2.34.1