[ARVADOS] updated: 153d327346a213d0d48430af835b871ef4283da5
git at public.curoverse.com
git at public.curoverse.com
Tue Feb 11 09:16:38 EST 2014
Summary of changes:
doc/Gemfile | 1 +
doc/Gemfile.lock | 2 ++
doc/Rakefile | 19 +++++++++++++------
.../{_0-filter_py.liquid => _0_filter_py.liquid} | 0
..._notebox-begin.liquid => _notebox_begin.liquid} | 0
.../{_notebox-end.liquid => _notebox_end.liquid} | 0
..._run-md5sum_py.liquid => _run_md5sum_py.liquid} | 0
doc/install/client.html.textile.liquid | 8 ++++----
.../running-external-program.html.textile.liquid | 2 +-
.../tutorial-firstscript.html.textile.liquid | 4 ++--
.../tutorial-new-pipeline.html.textile.liquid | 2 +-
11 files changed, 24 insertions(+), 14 deletions(-)
rename doc/_includes/{_0-filter_py.liquid => _0_filter_py.liquid} (100%)
rename doc/_includes/{_notebox-begin.liquid => _notebox_begin.liquid} (100%)
rename doc/_includes/{_notebox-end.liquid => _notebox_end.liquid} (100%)
rename doc/_includes/{_run-md5sum_py.liquid => _run_md5sum_py.liquid} (100%)
via 153d327346a213d0d48430af835b871ef4283da5 (commit)
from 956093639196f92f3ad4b9e0795bcc7e30520e0d (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
commit 153d327346a213d0d48430af835b871ef4283da5
Author: Peter Amstutz <peter.amstutz at curoverse.com>
Date: Tue Feb 11 09:17:39 2014 -0500
Python documentation step will now report a warning if epydoc isn't in PATH.
Fixed liquid include errors.
diff --git a/doc/Gemfile b/doc/Gemfile
index 497682b..381b706 100644
--- a/doc/Gemfile
+++ b/doc/Gemfile
@@ -3,3 +3,4 @@ source 'https://rubygems.org'
gem 'zenweb'
gem 'liquid'
gem 'RedCloth'
+gem 'colorize'
\ No newline at end of file
diff --git a/doc/Gemfile.lock b/doc/Gemfile.lock
index 048f27a..344a0a8 100644
--- a/doc/Gemfile.lock
+++ b/doc/Gemfile.lock
@@ -3,6 +3,7 @@ GEM
specs:
RedCloth (4.2.9)
coderay (1.1.0)
+ colorize (0.6.0)
kramdown (1.3.1)
less (1.2.21)
mutter (>= 0.4.2)
@@ -28,5 +29,6 @@ PLATFORMS
DEPENDENCIES
RedCloth
+ colorize
liquid
zenweb
diff --git a/doc/Rakefile b/doc/Rakefile
index 2ebd272..f2f3700 100644
--- a/doc/Rakefile
+++ b/doc/Rakefile
@@ -1,18 +1,25 @@
#!/usr/bin/env rake
require "rubygems"
+require "colorize"
+
Rake.application.rake_require "zenweb/tasks"
load "zenweb-textile.rb"
load "zenweb-liquid.rb"
-file ".site/sdk/python/arvados/index.html" do |t|
- sh "epydoc --html -o sdk/python/arvados arvados"
- Dir["sdk/python/arvados/*"].each do |f|
- puts f
- $website.pages[f] = Zenweb::Page.new($website, f)
+file "sdk/python/arvados/index.html" do |t|
+ `which epydoc`
+ if $? == 0
+ `epydoc --html -o sdk/python/arvados arvados`
+ Dir["sdk/python/arvados/*"].each do |f|
+ puts f
+ $website.pages[f] = Zenweb::Page.new($website, f)
+ end
+ else
+ puts "Warning: epydoc not found, Python documentation will not be generated".colorize(:light_red)
end
end
task :extra_wirings do
- $website.pages["sdk/python/python.html.textile.liquid"].depends_on(".site/sdk/python/arvados/index.html")
+ $website.pages["sdk/python/python.html.textile.liquid"].depends_on("sdk/python/arvados/index.html")
end
diff --git a/doc/_includes/_0-filter_py.liquid b/doc/_includes/_0_filter_py.liquid
similarity index 100%
rename from doc/_includes/_0-filter_py.liquid
rename to doc/_includes/_0_filter_py.liquid
diff --git a/doc/_includes/_notebox-begin.liquid b/doc/_includes/_notebox_begin.liquid
similarity index 100%
rename from doc/_includes/_notebox-begin.liquid
rename to doc/_includes/_notebox_begin.liquid
diff --git a/doc/_includes/_notebox-end.liquid b/doc/_includes/_notebox_end.liquid
similarity index 100%
rename from doc/_includes/_notebox-end.liquid
rename to doc/_includes/_notebox_end.liquid
diff --git a/doc/_includes/_run-md5sum_py.liquid b/doc/_includes/_run_md5sum_py.liquid
similarity index 100%
rename from doc/_includes/_run-md5sum_py.liquid
rename to doc/_includes/_run_md5sum_py.liquid
diff --git a/doc/install/client.html.textile.liquid b/doc/install/client.html.textile.liquid
index cc21938..f8d864a 100644
--- a/doc/install/client.html.textile.liquid
+++ b/doc/install/client.html.textile.liquid
@@ -9,9 +9,9 @@ h1. Install client libraries
h3. Python
-{% include 'notebox-begin' %}
+{% include 'notebox_begin' %}
The Python package includes the Python API client library module and the CLI utilities @arv-get@ and @arv-put at .
-{% include 'notebox-end' %}
+{% include 'notebox_end' %}
Get the arvados source tree.
@@ -29,8 +29,8 @@ Alternatively, build the package (without sudo) using @python setup.py bdist_egg
h3. Ruby
-{% include 'notebox-begin' %}
+{% include 'notebox_begin' %}
The arvados package includes the Ruby client library module. The arvados-cli package includes the CLI utilities @arv@, @arv-run-pipeline-instance@, and @crunch-job at .
-{% include 'notebox-end' %}
+{% include 'notebox_end' %}
notextile. <pre><code>$ <span class="userinput">sudo gem install arvados arvados-cli</span></code></pre>
diff --git a/doc/user/tutorials/running-external-program.html.textile.liquid b/doc/user/tutorials/running-external-program.html.textile.liquid
index 5a4320c..e286013 100644
--- a/doc/user/tutorials/running-external-program.html.textile.liquid
+++ b/doc/user/tutorials/running-external-program.html.textile.liquid
@@ -23,7 +23,7 @@ Start by entering the @crunch_scripts@ directory of your git repository:
Next, using your favorite text editor, create a new file called @run-md5sum.py@ in the @crunch_scripts@ directory. Add the following code to use the @md5sum@ program to compute the hash of each file in a collection:
-<pre><code class="userinput">{% include 'run-md5sum_py' %}</code></pre>
+<pre><code class="userinput">{% include 'run_md5sum_py' %}</code></pre>
Make the file executable:
diff --git a/doc/user/tutorials/tutorial-firstscript.html.textile.liquid b/doc/user/tutorials/tutorial-firstscript.html.textile.liquid
index d0108ea..2422bb2 100644
--- a/doc/user/tutorials/tutorial-firstscript.html.textile.liquid
+++ b/doc/user/tutorials/tutorial-firstscript.html.textile.liquid
@@ -36,13 +36,13 @@ Cloning into 'you'...</code></pre>
This will create an git checkout in the directory called @you at .
-{% include 'notebox-begin' %}
+{% include 'notebox_begin' %}
For more information about using @git@, try
notextile. <pre><code>$ <span class="userinput">man gittutorial</span></code></pre>
or <b>"click here to search Google for git tutorials":http://google.com/#q=git+tutorial</b>
-{% include 'notebox-end' %}
+{% include 'notebox_end' %}
h2. Creating a Crunch script
diff --git a/doc/user/tutorials/tutorial-new-pipeline.html.textile.liquid b/doc/user/tutorials/tutorial-new-pipeline.html.textile.liquid
index 8312237..0083166 100644
--- a/doc/user/tutorials/tutorial-new-pipeline.html.textile.liquid
+++ b/doc/user/tutorials/tutorial-new-pipeline.html.textile.liquid
@@ -16,7 +16,7 @@ h2. Create a new script
Our second script will filter the output of @parallel_hash.py@ and only include hashes that start with 0. Create a new script in @crunch_scripts/@ called @0-filter.py@:
-<pre><code class="userinput">{% include '0-filter_py' %}</code></pre>
+<pre><code class="userinput">{% include '0_filter_py' %}</code></pre>
Now add it to git:
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list