0b6f8feec2
We tried building Gerrit's documentation using the asciidoctor's standard CSS style and for many people the result looks better than Gerrit's default doc.css. The search box is rendered with fixed position now. With the asciidoctor default style sheet the "position:absolute" attribute no longer worked as intended, because there are other elements in the page with a "position" attribute. So the search box was placed randomly somewhere next to a section header and screwed up the text layout completely. Test Plan: $ buck build Documentation:html $ open buck-out/gen/Documentation/html__tmp/Documentation/index.html Change-Id: Ia276aeb5c79b9fbd9589db444a83c084f07aee40 Also-by: Michael Ochmann <michael.ochmann@sap.com>
112 lines
2.9 KiB
Plaintext
112 lines
2.9 KiB
Plaintext
# Copyright (C) 2013 The Android Open Source Project
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
def genasciidoc_htmlonly(
|
|
name,
|
|
out,
|
|
srcs = [],
|
|
attributes = [],
|
|
backend = None,
|
|
searchbox = True,
|
|
visibility = []):
|
|
EXPN = '.' + name + '_expn'
|
|
|
|
asciidoc = [
|
|
'$(exe //lib/asciidoctor:asciidoc)',
|
|
'-z', '$OUT',
|
|
'--base-dir', '$SRCDIR',
|
|
'--tmp', '$TMP',
|
|
'--in-ext', '".txt%s"' % EXPN,
|
|
'--out-ext', '".html"',
|
|
]
|
|
if backend:
|
|
asciidoc.extend(['-b', backend])
|
|
for attribute in attributes:
|
|
asciidoc.extend(['-a', attribute])
|
|
asciidoc.append('$SRCS')
|
|
newsrcs = []
|
|
for src in srcs:
|
|
fn = src
|
|
# We have two cases: regular source files and generated files.
|
|
# Generated files are passed as targets ':foo', and ':' is removed.
|
|
# 1. regular files: cmd = '-s foo', srcs = ['foo']
|
|
# 2. generated files: cmd = '-s $(location :foo)', srcs = []
|
|
srcs = [src]
|
|
passed_src = fn
|
|
if fn.startswith(':') :
|
|
fn = src[1:]
|
|
srcs = []
|
|
passed_src = '$(location :%s)' % fn
|
|
ex = fn + EXPN
|
|
|
|
genrule(
|
|
name = ex,
|
|
cmd = '$(exe :replace_macros) --suffix="%s"' % EXPN +
|
|
' -s ' + passed_src + ' -o $OUT' +
|
|
(' --searchbox' if searchbox else ' --no-searchbox'),
|
|
srcs = srcs,
|
|
out = ex,
|
|
)
|
|
|
|
newsrcs.append(':%s' % ex)
|
|
|
|
genrule(
|
|
name = name,
|
|
cmd = ' '.join(asciidoc),
|
|
srcs = newsrcs,
|
|
out = out,
|
|
visibility = visibility,
|
|
)
|
|
|
|
def genasciidoc(
|
|
name,
|
|
out,
|
|
docdir,
|
|
srcs = [],
|
|
attributes = [],
|
|
backend = None,
|
|
searchbox = True,
|
|
visibility = []):
|
|
SUFFIX = '_htmlonly'
|
|
|
|
genasciidoc_htmlonly(
|
|
name = name + SUFFIX,
|
|
srcs = srcs,
|
|
attributes = attributes,
|
|
backend = backend,
|
|
searchbox = searchbox,
|
|
out = name + SUFFIX + '.zip',
|
|
)
|
|
|
|
genrule(
|
|
name = name,
|
|
cmd = 'cd $TMP;' +
|
|
'mkdir -p %s/images;' % docdir +
|
|
'unzip -q $(location %s) -d %s/;'
|
|
% (':' + name + SUFFIX, docdir) +
|
|
'for s in $SRCS;do ln -s $s %s;done;' % docdir +
|
|
'mv %s/*.{jpg,png} %s/images;' % (docdir, docdir) +
|
|
'cp $(location %s) LICENSES.txt;' % ':licenses.txt' +
|
|
'zip -qr $OUT *',
|
|
srcs = glob([
|
|
'images/*.jpg',
|
|
'images/*.png',
|
|
]) + [
|
|
'//gerrit-prettify:prettify.min.css',
|
|
'//gerrit-prettify:prettify.min.js',
|
|
],
|
|
out = out,
|
|
visibility = visibility,
|
|
)
|