New: Jake command for building a Docset

This commit adds the `docset` command to jake, to create a Docset from a doxygen build. It adds a shell script to the "support" directory that manages the build, and includes an Info.plist file that gets copied to the Docset when built.
This commit is contained in:
Andrew Hankinson committed 2014-12-19 13:16:05 -05:00
1 parent 8ef7cacdda
commit a48df23252
3 files changed
+47

No files matched your search

+9
View File
@@ -111,6 +111,15 @@ task ("documentation-no-frame", function()
generateDocs(true);
});
task ("docset", function()
{
// generateDocs(true);
var documentationDir = FILE.canonical(FILE.join("Tools", "Documentation")),
docsetShell = FILE.join(documentationDir, "support", "docset.sh");
OS.system([docsetShell, documentationDir]);
});
function generateDocs(/* boolean */ noFrame)
{
// try to find a doxygen executable in the PATH;
+13
View File
@@ -0,0 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN"
"http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleName</key>
<string>Cappuccino</string>
<key>CFBundleIdentifier</key>
<string>cappuccino</string>
<key>DocSetPlatformFamily</key>
<string>cappuccino</string>
</dict>
</plist>
+25
View File
@@ -0,0 +1,25 @@
#!/usr/bin/env bash
source "$1"/support/processor_setup.sh
processor_msg "Generating Docset"
MAKEFILE="Build/Documentation/html/Makefile"
DOCSDIR="Build/Documentation/html"
processor_msg "Massaging Makefile"
sed -i '.bak' 's/docsetutil index \$(DOCSET_NAME)/docsetutil index -skip-text \$(DOCSET_NAME)/g' $MAKEFILE
pushd $DOCSDIR
processor_msg "Running Make"
make
processor_msg "Finishing up"
mv "org.cappuccino-project.cappuccino.docset" "Cappuccino.docset"
cp "$1"/Info.plist "Cappuccino.docset/Contents"
popd
processor_msg "Moving docset to Build/Documentation"
mv "$DOCSDIR"/Cappuccino.docset "Build/Documentation"
processor_msg "Done"