optimized grabber and build scripts

pfefferle · Mar 20, 2015 · fc835e2 · fc835e2
1 parent 09c3dee
commit fc835e2
Show file tree

Hide file tree

Showing 16 changed files with 26 additions and 22 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,11 +1,2 @@
-SlimFramework.docset/Contents/Resources/Document
-SlimFramework.docset/Contents/Resources/Documents/hts-cache/*
-SlimFramework.docset/Contents/Resources/Documents/docs.slimframework.com/_themes/*
-SlimFramework.docset/Contents/Resources/Documents/fade.gif
-SlimFramework.docset/Contents/Resources/Documents/hts-log.txt
-SlimFramework.docset/Contents/Resources/Documents/index.html
-SlimFramework.docset/Contents/Resources/Documents/docs.slimframework.com/pages/view-rendering-templates.html
-
-SlimFramework.docset/Contents/Resources/Documents/backblue.gif
-
+cache
 slimframework.tgz
diff --git a/README.md b/README.md
@@ -2,19 +2,29 @@
 
 dash-slimframework is a docset for [Dash.app][] containing the latest SlimFramework documentation.
 
+![](screenshot.png)
+
 ## Installing
 
 Install by opening Dash.app preferences, switch to `Downloads`, click `+`, and enter the feed URL
 `https://raw.githubusercontent.com/pfefferle/dash-slimframework/master/SlimFramework.xml`.
 
+## Build
+
+To rebuild or update this docset run the following commands in the following order:
+
+1. `$ sh sync.sh` to grab the newest version of the documentation
+1. `$ python rebuild.py` to generate the docset from the grabbed sources
+1. `$ sh pack.sh` to build the tgz file for a new release
 
 ## Thanks
 
 The [`sync.sh`][] and [`rebuild.py`][] scripts are based on [@willnorris][]' awesome [RFCDash Docset][] versions.
 
 [Dash.app]: http://kapeli.com/dash
 [open an issue]: https://github.com/pfefferle/dash-slimframework/issues
-[`sync.sh`]: https://github.com/pfefferle/dash-slimframework/blob/master/sync
+[`pack.sh`]: https://github.com/pfefferle/dash-slimframework/blob/master/pack.sh
+[`sync.sh`]: https://github.com/pfefferle/dash-slimframework/blob/master/sync.sh
 [`rebuild.py`]: https://github.com/pfefferle/dash-slimframework/blob/master/rebuild.py
 [@willnorris]: https://willnorris.com
 [RFCDash Docset]: https://github.com/willnorris/rfcdash
diff --git a/...rk.docset/Contents/Resources/Documents/docs.slimframework.com/bootstrap/css/bootstrap.css b/...rk.docset/Contents/Resources/Documents/docs.slimframework.com/bootstrap/css/bootstrap.css
diff --git a/...s/Documents/docs.slimframework.com/bootstrap/img/glyphicons-halflings-white.png b/...s/Documents/docs.slimframework.com/bootstrap/img/glyphicons-halflings-white.png
diff --git a/...sources/Documents/docs.slimframework.com/bootstrap/img/glyphicons-halflings.png b/...sources/Documents/docs.slimframework.com/bootstrap/img/glyphicons-halflings.png
diff --git a/SlimFramework.docset/Contents/Resources/Documents/docs.slimframework.com/index.html b/SlimFramework.docset/Contents/Resources/Documents/docs.slimframework.com/index.html
@@ -1,5 +1,5 @@
 <!DOCTYPE html>
-<html><!-- Mirrored from docs.slimframework.com/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 17 Mar 2015 14:29:34 GMT --><head>
+<html><!-- Mirrored from docs.slimframework.com/ by HTTrack Website Copier/3.x [XR&CO'2014], Fri, 20 Mar 2015 21:00:06 GMT --><head>
         <meta charset="utf-8"/>
         <title>Slim Framework Documentation</title>
         <link href="bootstrap/css/bootstrap.css" rel="stylesheet"/>
@@ -2602,7 +2602,7 @@ <h2 class="page-article-header">View Data</h2>
                     <div class="alert alert-info">
     <strong>Heads Up!</strong> Rarely will you set or append data directly on the view object. Usually, you
     pass data to the view with the Slim application’s `render()` method.
-    See <a href="pages/view-rendering-templates.html">Rendering Templates</a>.
+    See <a href="http://docs.slimframework.com/pages/view-rendering-templates">Rendering Templates</a>.
 </div>
 
 <p>The view object’s <code>setData()</code> and <code>appendData()</code> methods inject data into the view object; the injected data is
@@ -3600,4 +3600,4 @@ <h3>Closure resources</h3>
 
 
 
-</body><!-- Mirrored from docs.slimframework.com/ by HTTrack Website Copier/3.x [XR&CO'2014], Tue, 17 Mar 2015 14:29:34 GMT --></html>
+</body><!-- Mirrored from docs.slimframework.com/ by HTTrack Website Copier/3.x [XR&CO'2014], Fri, 20 Mar 2015 21:00:07 GMT --></html>
diff --git a/SlimFramework.docset/Contents/Resources/Documents/docs.slimframework.com/styles/css/all.css b/SlimFramework.docset/Contents/Resources/Documents/docs.slimframework.com/styles/css/all.css
@@ -1,6 +1,6 @@
 .mbs{margin-bottom:20px;}
 .pts{padding-top:20px;}
-@font-face{font-family:'FontAwesome';src:url('http://docs.slimframework.com/styles/font/fontawesome-webfont.eot?v=3.0.1');src:url('http://docs.slimframework.com/styles/font/fontawesome-webfont.eot?#iefix&v=3.0.1') format('embedded-opentype'),url('http://docs.slimframework.com/styles/font/fontawesome-webfont.woff?v=3.0.1') format('woff'),url('http://docs.slimframework.com/styles/font/fontawesome-webfont.ttf?v=3.0.1') format('truetype');font-weight:normal;font-style:normal;}[class^="icon-"],[class*=" icon-"]{font-family:FontAwesome;font-weight:normal;font-style:normal;text-decoration:inherit;-webkit-font-smoothing:antialiased;display:inline;width:auto;height:auto;line-height:normal;vertical-align:baseline;background-image:none;background-position:0% 0%;background-repeat:repeat;margin-top:0;}
+@font-face{font-family:'FontAwesome';src:url('../font/fontawesome-webfont3294.eot?v=3.0.1');src:url('../font/fontawesome-webfontd41d.eot?#iefix&v=3.0.1') format('embedded-opentype'),url('../font/fontawesome-webfont3294.woff?v=3.0.1') format('woff'),url('../font/fontawesome-webfont3294.ttf?v=3.0.1') format('truetype');font-weight:normal;font-style:normal;}[class^="icon-"],[class*=" icon-"]{font-family:FontAwesome;font-weight:normal;font-style:normal;text-decoration:inherit;-webkit-font-smoothing:antialiased;display:inline;width:auto;height:auto;line-height:normal;vertical-align:baseline;background-image:none;background-position:0% 0%;background-repeat:repeat;margin-top:0;}
 .icon-white,.nav-pills>.active>a>[class^="icon-"],.nav-pills>.active>a>[class*=" icon-"],.nav-list>.active>a>[class^="icon-"],.nav-list>.active>a>[class*=" icon-"],.navbar-inverse .nav>.active>a>[class^="icon-"],.navbar-inverse .nav>.active>a>[class*=" icon-"],.dropdown-menu>li>a:hover>[class^="icon-"],.dropdown-menu>li>a:hover>[class*=" icon-"],.dropdown-menu>.active>a>[class^="icon-"],.dropdown-menu>.active>a>[class*=" icon-"],.dropdown-submenu:hover>a>[class^="icon-"],.dropdown-submenu:hover>a>[class*=" icon-"]{background-image:none;}
 [class^="icon-"]:before,[class*=" icon-"]:before{text-decoration:inherit;display:inline-block;speak:none;}
 a [class^="icon-"],a [class*=" icon-"]{display:inline-block;}

diff --git a/...ntents/Resources/Documents/docs.slimframework.com/styles/font/fontawesome-webfont3294.eot b/...ntents/Resources/Documents/docs.slimframework.com/styles/font/fontawesome-webfont3294.eot
diff --git a/...ntents/Resources/Documents/docs.slimframework.com/styles/font/fontawesome-webfont3294.ttf b/...ntents/Resources/Documents/docs.slimframework.com/styles/font/fontawesome-webfont3294.ttf
diff --git a/...tents/Resources/Documents/docs.slimframework.com/styles/font/fontawesome-webfont3294.woff b/...tents/Resources/Documents/docs.slimframework.com/styles/font/fontawesome-webfont3294.woff
diff --git a/...ntents/Resources/Documents/docs.slimframework.com/styles/font/fontawesome-webfontd41d.eot b/...ntents/Resources/Documents/docs.slimframework.com/styles/font/fontawesome-webfontd41d.eot
diff --git a/SlimFramework.docset/Contents/Resources/docSet.dsidx b/SlimFramework.docset/Contents/Resources/docSet.dsidx
diff --git a/SlimFramework.xml b/SlimFramework.xml
@@ -1,4 +1,4 @@
 <entry>
-    <version>1.0.0</version>
-    <url>https://github.com/pfefferle/dash-slimframework/releases/download/v1.0.0/slimframework.tgz</url>
+    <version>1.0.1</version>
+    <url>https://github.com/pfefferle/dash-slimframework/releases/download/v1.0.1/slimframework.tgz</url>
 </entry>
diff --git a/pack.sh b/pack.sh
@@ -0,0 +1,3 @@
+#!/bin/sh
+
+tar --exclude='.DS_Store' -cvzf slimframework.tgz SlimFramework.docset
diff --git a/screenshot.png b/screenshot.png
diff --git a/sync.sh b/sync.sh
@@ -1,10 +1,10 @@
 #!/bin/sh
 
-cd SlimFramework.docset/Contents/Resources/Documents
-
 httrack http://docs.slimframework.com/ \
+  -O SlimFramework.docset/Contents/Resources/Documents,cache -I0 \
   --display=2 --timeout=60 --retries=99 --sockets=7 \
   --connection-per-second=5 --max-rate=250000 \
-  --keep-alive --depth=2 --mirror --robots=0 \
+  --keep-alive --depth=5 --mirror --clean --robots=0 \
   --user-agent '$(httrack --version); dash-slimframework ()' \
+  "-docs.slimframework.com/_themes/*" "-docs.slimframework.com/pages/*" \
   "+docs.slimframework.com/bootstrap/css/*" "+docs.slimframework.com/styles/*"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		#!/bin/sh

		tar --exclude='.DS_Store' -cvzf slimframework.tgz SlimFramework.docset