[Swift-commit] r4972 - in trunk/docs: . siteguide stylesheets

[davidk at ci.uchicago.edu]

Author: davidk
Date: 2011-08-09 20:48:34 -0500 (Tue, 09 Aug 2011)
New Revision: 4972

Added:
   trunk/docs/README
   trunk/docs/siteguide/images
   trunk/docs/stylesheets/
   trunk/docs/stylesheets/asciidoc.css
Modified:
   trunk/docs/build_docs.sh
Log:
Various doc updates


Added: trunk/docs/README
===================================================================
--- trunk/docs/README	                        (rev 0)
+++ trunk/docs/README	2011-08-10 01:48:34 UTC (rev 4972)
@@ -0,0 +1,11 @@
+Prerequisites to building documentation:
+
+* asciidoc and a2x (http://www.methods.co.nz/asciidoc)
+* dblatex (http://dblatex.sourceforge.net)
+* source-highlight (http://www.gnu.org/software/src-highlite)
+
+For CI users, compiled versions of these packages can be found in ~davidk.
+
+To build, run:
+
+build_docs.sh <installation_dir>

Modified: trunk/docs/build_docs.sh
===================================================================
--- trunk/docs/build_docs.sh	2011-08-10 01:39:53 UTC (rev 4971)
+++ trunk/docs/build_docs.sh	2011-08-10 01:48:34 UTC (rev 4972)
@@ -14,12 +14,12 @@
 GROUP="vdl2-svn"
 
 # Verify correct arguments
-if [ -n "$1" ]; then
-   INSTALLATION_DIRECTORY=$1
-else
-   crash "Error: Must specify a directory for installation"
+if [ -z "$1" ] || [ "$1" == "-h" ] || [ "$1" == "-help" ]; then
+   crash "Usage: ./build_docs.sh /path/to/copy/output"
 fi
 
+INSTALLATION_DIRECTORY=$1
+
 # Create installation directory if needed
 if [ ! -d "$INSTALLATION_DIRECTORY" ]; then
    mkdir $INSTALLATION_DIRECTORY || crash "Unable to create directory $INSTALLATION_DIRECTORY"
@@ -43,7 +43,7 @@
    for file in $FILES
    do
       echo Converting $directory"$file" to HTML
-      asciidoc -a toc -a max-width=750px $file
+      asciidoc -a toc -a max-width=750px -a stylesheet=$(pwd)/../stylesheets/asciidoc.css $file
       echo Converting $directory"$file" to PDF
       a2x --format=pdf --no-xmllint $file 
    done

Added: trunk/docs/siteguide/images
===================================================================
--- trunk/docs/siteguide/images	                        (rev 0)
+++ trunk/docs/siteguide/images	2011-08-10 01:48:34 UTC (rev 4972)
@@ -0,0 +1 @@
+link ../tutorial/images
\ No newline at end of file


Property changes on: trunk/docs/siteguide/images
___________________________________________________________________
Added: svn:special
   + *

Added: trunk/docs/stylesheets/asciidoc.css
===================================================================
--- trunk/docs/stylesheets/asciidoc.css	                        (rev 0)
+++ trunk/docs/stylesheets/asciidoc.css	2011-08-10 01:48:34 UTC (rev 4972)
@@ -0,0 +1,2 @@
+a:link { color:navy; }
+a:visited { color:navy; }