opendev/gerrit
Code Issues Proposed changes

Make the documentation embedding work.

Browse Source 
Bug: Issue 2199
Change-Id: Ib0e6d412f3e5523834b4b977728551e2be0d3a86
This commit is contained in:
Yuxuan 'fishy' Wang
2013-10-17 09:36:33 -07:00
committed by David Pursehouse
parent 86fcd77c44
commit a487b6cf87
2 changed files with 17 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/asciidoc.defs
View File

@@ -23,6 +23,7 @@ def genasciidoc(
EXPN = '.expn' EXPN = '.expn'
asciidoc = [ asciidoc = [
'cd $SRCDIR;',
'$(exe //lib/asciidoctor:asciidoc)', '$(exe //lib/asciidoctor:asciidoc)',
'-z', '$OUT', '-z', '$OUT',
'--in-ext', '".txt%s"' % EXPN, '--in-ext', '".txt%s"' % EXPN,
@@ -33,7 +34,7 @@ def genasciidoc(
for attribute in attributes: for attribute in attributes:
asciidoc.extend(['-a', attribute]) asciidoc.extend(['-a', attribute])
asciidoc.append('$SRCS') asciidoc.append('$SRCS')
newsrcs = [] newsrcs = ["doc.css"]
newdeps = deps + ['//lib/asciidoctor:asciidoc'] newdeps = deps + ['//lib/asciidoctor:asciidoc']
for src in srcs: for src in srcs:

22
lib/asciidoctor/java/AsciiDoctor.java
View File

@@ -29,6 +29,7 @@ import org.asciidoctor.Asciidoctor;
import org.asciidoctor.AttributesBuilder; import org.asciidoctor.AttributesBuilder;
import org.asciidoctor.Options; import org.asciidoctor.Options;
import org.asciidoctor.OptionsBuilder; import org.asciidoctor.OptionsBuilder;
import org.asciidoctor.SafeMode;
import org.asciidoctor.internal.JRubyAsciidoctor; import org.asciidoctor.internal.JRubyAsciidoctor;
import org.kohsuke.args4j.Argument; import org.kohsuke.args4j.Argument;
@@ -75,15 +76,16 @@ public class AsciiDoctor {
return basename + outExt; return basename + outExt;
} }
private Options createOptions(File tmpFile) { private Options createOptions(File outputFile) {
OptionsBuilder optionsBuilder = OptionsBuilder.options(); OptionsBuilder optionsBuilder = OptionsBuilder.options();
optionsBuilder.backend(backend).docType(DOCTYPE).eruby(ERUBY); optionsBuilder.backend(backend).docType(DOCTYPE).eruby(ERUBY)
.safe(SafeMode.UNSAFE);
// XXX(fishywang): ideally we should just output to a string and add the // XXX(fishywang): ideally we should just output to a string and add the
// content into zip. But asciidoctor will actually ignore all attributes if // content into zip. But asciidoctor will actually ignore all attributes if
// not output to a file. So we *have* to output to a file then read the // not output to a file. So we *have* to output to a file then read the
// content of the file into zip. // content of the file into zip.
optionsBuilder.toFile(tmpFile); optionsBuilder.toFile(outputFile);
AttributesBuilder attributesBuilder = AttributesBuilder.attributes(); AttributesBuilder attributesBuilder = AttributesBuilder.attributes();
attributesBuilder.attributes(getAttributes()); attributesBuilder.attributes(getAttributes());
@@ -127,12 +129,18 @@ public class AsciiDoctor {
ZipOutputStream zip = new ZipOutputStream(new FileOutputStream(zipFile)); ZipOutputStream zip = new ZipOutputStream(new FileOutputStream(zipFile));
for (String inputFile : inputFiles) { for (String inputFile : inputFiles) {
File tmp = File.createTempFile("doc", ".html"); if (!inputFile.endsWith(inExt)) {
Options options = createOptions(tmp); // We have to use UNSAFE mode in order to make embedding work. But in
// UNSAFE mode we'll also need css file in the same directory, so we
// have to add css files into the SRCS.
continue;
}
String outName = mapInFileToOutFile(inputFile, inExt, outExt);
File out = new File(outName);
Options options = createOptions(out);
renderInput(options, inputFile); renderInput(options, inputFile);
String outputFile = mapInFileToOutFile(inputFile, inExt, outExt); zipFile(out, outName, zip);
zipFile(tmp, outputFile, zip);
} }
zip.close(); zip.close();
} }