From 3b4470e7577adfb3a0ff1e6e4f721ecdfde53d3e Mon Sep 17 00:00:00 2001 From: Luke Shumaker Date: Mon, 5 Dec 2016 13:47:46 -0500 Subject: Upgrade yuidoc 1.0.0b1 -> 50 yuidoc 1.0.0b1 was crashing on jarmon.test.js. --- jarmonbuild/commands.py | 13 ++- jarmonbuild/yuidoc_template.patch | 45 +++----- jarmonbuild/yuidoc_template/assets/ac-js | 56 ++++++---- jarmonbuild/yuidoc_template/assets/api-js | 54 +++++----- jarmonbuild/yuidoc_template/assets/api.css | 15 +-- jarmonbuild/yuidoc_template/main.tmpl | 160 +++++++++++++++-------------- 6 files changed, 177 insertions(+), 166 deletions(-) diff --git a/jarmonbuild/commands.py b/jarmonbuild/commands.py index 87b9a22..e4c20ca 100644 --- a/jarmonbuild/commands.py +++ b/jarmonbuild/commands.py @@ -24,10 +24,12 @@ import pkg_resources JARMON_PROJECT_TITLE = 'Jarmon' JARMON_PROJECT_URL = 'http://www.launchpad.net/jarmon' +JARMON_COPYRIGHT = 'Richard Wall' -YUIDOC_URL = 'http://yui.zenfs.com/releases/yuidoc/yuidoc_1.0.0b1.zip' -YUIDOC_MD5 = 'cd5545d2dec8f7afe3d18e793538162c' -YUIDOC_DEPENDENCIES = ['setuptools', 'pygments', 'cheetah'] +YUIDOC_URL = 'https://github.com/yui/yuidoc/archive/yuidoc-50.zip' +YUIDOC_DIR = 'yuidoc-yuidoc-50' +YUIDOC_MD5 = '725fc7cdf349f8dfd20d487841e9d3b9' +YUIDOC_DEPENDENCIES = ['pygments', 'cheetah'] class BuildError(Exception): @@ -130,14 +132,14 @@ class BuildApidocsCommand(BuildCommand): # Remove any existing apidocs so that we can track removed files shutil.rmtree(os.path.join(build_dir, 'docs', 'apidocs'), True) - yuidoc_dir = os.path.join(build_dir, 'yuidoc') + yuidoc_dir = os.path.join(build_dir, YUIDOC_DIR) # extract yuidoc folder from the downloaded zip file self.log.debug( 'Extracting YUI Doc from %s to %s' % (yuizip_path, yuidoc_dir)) zip = ZipFile(yuizip_path) zip.extractall( - build_dir, (m for m in zip.namelist() if m.startswith('yuidoc'))) + build_dir, (m for m in zip.namelist() if m.startswith(YUIDOC_DIR))) # Use the yuidoc script that we just extracted to generate new docs self.log.debug('Running YUI Doc') @@ -155,6 +157,7 @@ class BuildApidocsCommand(BuildCommand): '--version=%s' % (buildversion,), '--project=%s' % (JARMON_PROJECT_TITLE,), '--projecturl=%s' % (JARMON_PROJECT_URL,), + '--copyright=%s.' % (JARMON_COPYRIGHT,), ), stdout=PIPE, stderr=PIPE,) shutil.rmtree(yuidoc_dir) diff --git a/jarmonbuild/yuidoc_template.patch b/jarmonbuild/yuidoc_template.patch index 510e90e..1e1b948 100644 --- a/jarmonbuild/yuidoc_template.patch +++ b/jarmonbuild/yuidoc_template.patch @@ -1,6 +1,6 @@ -diff -ruw template.yui/assets/api.css template.jarmon/assets/api.css ---- template.yui/assets/api.css 2008-12-03 12:35:44.000000000 -0500 -+++ template.jarmon/assets/api.css 2016-12-05 04:17:24.002415498 -0500 +diff -ru template.orig/assets/api.css yuidoc_template/assets/api.css +--- template.orig/assets/api.css 2016-12-05 11:50:33.853055029 -0500 ++++ yuidoc_template/assets/api.css 2016-12-05 12:14:33.454839017 -0500 @@ -7,7 +7,7 @@ a:visited { color: #003399;} @@ -10,28 +10,20 @@ diff -ruw template.yui/assets/api.css template.jarmon/assets/api.css #doc3 #hd h1 a { position: relative; top: 14px; } #doc3 #hd a { text-decoration: none; color: black; } #doc3 #hd h3 { -diff -ruw template.yui/main.tmpl template.jarmon/main.tmpl ---- template.yui/main.tmpl 2008-12-05 15:28:02.000000000 -0500 -+++ template.jarmon/main.tmpl 2016-12-05 12:06:34.352026870 -0500 -@@ -4,20 +4,20 @@ +Only in template.orig/assets: yui.png +diff -ru template.orig/main.tmpl yuidoc_template/main.tmpl +--- template.orig/main.tmpl 2016-12-05 11:50:33.853055029 -0500 ++++ yuidoc_template/main.tmpl 2016-12-05 12:33:53.828316623 -0500 +@@ -3,7 +3,7 @@ - API: $modulename #if $classname# $classname #end if# #if $filename# $filename #end if# (YUI Library) + API: $modulename #if $classname# $classname #end if# #if $filename# $filename #end if# -- -- -+ -+ - -- -- -+ -+ - - - + + +@@ -16,7 +16,7 @@
@@ -40,23 +32,12 @@ diff -ruw template.yui/main.tmpl template.jarmon/main.tmpl

$moduletitle  $version

$projectname #if $modulename -@@ -49,8 +49,8 @@ +@@ -48,7 +48,7 @@ #if $index
- This is the API documentation for the -- Yahoo! User Interface Library. + This is the API documentation for -+ $projectname. + $projectname.

Choose a module name from the list for more information.

- -@@ -669,7 +669,7 @@ -
-
-
-- Copyright © $year Yahoo! Inc. All rights reserved. -+ Copyright © $year Richard Wall. All rights reserved. -
-
- - + +
-
+

$projectname v$version API Documentation

$moduletitle  $version

- $projectname + $projectname #if $modulename > $modulename #if $classname# > $classname #end if# @@ -33,11 +32,11 @@
-
+ -
-
-
+
+
+
Filters @@ -61,9 +60,9 @@ - #include raw $filepath_highlighted + $highlightcontent
- #else if $classname + #else if $classname

#if $access#$access#end if# @@ -78,19 +77,19 @@ #if $uses - - uses + - uses #set $i=0 #for $provider in $uses##if $i > 0#, #end if# $provider#set $i=$i+1# #end for# - + #end if

- + #if $subclasses
Known Subclasses:
@@ -103,11 +102,11 @@
#end if - + #if $deprecated
Deprecated: $deprecated
#end if - + #if $see
See also: $see
#end if @@ -127,7 +126,7 @@ #if $constructor.params #set $i=0 #set $current="" - + #for $param in $constructor.params# #if $current != $param.name #if $i > 0#, #end if# @@ -153,7 +152,7 @@ #end for #end if - + #if $constructor.return
Returns:
@@ -161,14 +160,14 @@ $constructor.return
- #end if - + #end if +
#end if - +
#if $properties
@@ -184,18 +183,18 @@ $property.description
- - + + #if $property.default
Default Value: $property.default -
+
#end if #if $property.deprecated
Deprecated: $property.deprecated -
+ #end if
@@ -259,7 +258,7 @@ #end if ) - +
$method.description
@@ -280,11 +279,13 @@ #end if - #if $method.return.type + #if $method.return.description
Returns: - $method.return.type + #if $method.return.type + $method.return.type + #end if
$method.return.description
@@ -293,14 +294,14 @@ #if $method.chainable
Chainable: This method is chainable. -
+ #end if - + #if $method.deprecated
Deprecated $method.deprecated -
+ #end if @@ -314,7 +315,7 @@ #end if #if $inherited.methods -
+
#for $superclassname in $inherited.methods

Methods inherited from $superclassname:

@@ -323,7 +324,7 @@ #set i=0 #set l=len($inherited.methods[$superclassname])-1 #for $method in $inherited.methods[$superclassname] - + $method.name#if $i<$l#,#end if# #set i=i+1 @@ -368,7 +369,7 @@ ) - +
$event.description
@@ -386,7 +387,7 @@ $param.description - + #end for #end if @@ -394,18 +395,18 @@ #if $event.bubbles
Bubbles: This event bubbles to $event.bubbles. -
+
#end if #if $event.preventable
- Preventable: This event is preventable by method: $event.preventable. -
+ Preventable: This event is preventable by method e.preventDefault(). The default function executed by this event is $event.preventable. +
#end if #if $event.deprecated
Deprecated $event.deprecated -
+
#end if @@ -419,7 +420,7 @@ #if $inherited.events -
+
#for $superclassname in $inherited.events

Events inherited from $superclassname:

@@ -456,21 +457,21 @@ $config.description
- + #if $config.deprecated
Deprecated $config.deprecated -
+
#end if - + #if $config.default
Default Value: $config.default -
+ #end if
- + #end for @@ -478,17 +479,17 @@ #end if #if $inherited.configs -
+
#for $superclassname in $inherited.configs

Configuration attributes inherited from $superclassname:

#set i=0 - #set l=len($inherited.methods[$superclassname])-1 + #set l=len($inherited.configs[$superclassname])-1 #for $config in $inherited.configs[$superclassname] #set i=i+1 - + $config.name#if $i<$l#,#end if# #set i=i+1 @@ -502,9 +503,9 @@
#else if $modulename - +

Module: $modulename - + #if $beta Beta #end if @@ -554,12 +555,12 @@ #for $info in $submodules #set count = count + 1 #end for - #if count != 0 + #if count != 0
-

Submodules:

+

Submodules:

#for $info in $submodules -
$info
+
$info
$subdata[$info].description
#end for
@@ -570,9 +571,9 @@
#end if -

-
-
+
+
+
#if $modulenames @@ -584,7 +585,8 @@ #if $moduledef == $modulename #set $css = "selected" #end if -
  • $moduledef
    • + #set $cleansedname = $cleansedmodulenames[$moduledef] +
  • $moduledef
    • #end for
    @@ -608,7 +610,7 @@ #if $filenames

    Files

    -
      +
        #for $filedef in $filenames #set $css = "" #if $filedef == $filename @@ -623,7 +625,7 @@ #if $properties

        Properties

        -
          +
            #for $prop in $properties
          • $prop.name
            • #end for @@ -634,7 +636,7 @@ #if $methods

            Methods

            -
              +
                #for $method in $methods
              • $method.name
                • #end for @@ -645,7 +647,7 @@ #if $events

                Events

                -
                  +
                    #for $event in $events
                  • $event.name
                    • #end for @@ -656,7 +658,7 @@ #if $configs

                    Configuration Attributes

                    -
                      +
                        #for $config in $configs
                      • $config.name
                        • #end for @@ -665,21 +667,29 @@ #end if
                    -
                -
            -
            +
            +
        +
        - Copyright © $year Richard Wall. All rights reserved. -
        + Copyright © $year $copyrighttag All rights reserved. +
    #if $ydn - - + + + + #end if -#end filter -- cgit v1.2.3