rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-25 07:23:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

waf: Users without the extra fonts need to use '--disable-extra-fonts' to build PDF.

Browse Source
This commit is contained in:
Chris Johns 2016-11-09 17:08:05 +11:00
parent 5431beb472
commit 9330bfbaa7
3 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.txt
View File

@ -18,7 +18,7 @@ The RTEMS Documentation output formats are:
PDF - Single PDF per manual. PDF - Single PDF per manual.
SIngle HTML - Single HTML, one file per manual. SIngle HTML - Single HTML, one file per manual.
The PDF format is cerated using Latex and that uses texlive packages. This The PDF format is created using Latex and that uses texlive packages. This
exposes us to the complex world of Latex however the quality of the documents exposes us to the complex world of Latex however the quality of the documents
created is worth it. created is worth it.
@ -229,12 +229,17 @@ Note: waf-1.9.5 is a little noisy when running tex builds and tests. I hope
To build enter in the top directory: To build enter in the top directory:
$ ./waf configure [--pdf] [--singlehtml] [--prefix] [--sphinx-verbose] $ ./waf configure [--pdf] [--singlehtml] [--prefix] \
[--sphinx-verbose] [--disable-extra-fonts]
$ ./waf $ ./waf
The '--pdf' and '--singlehtml' options can be added to configure to build those The '--pdf' and '--singlehtml' options can be added to configure to build those
output formats. output formats.
The '--disable-extra-fonts' allows you to build PDF documents with out the
fonts we use for a better quality document. Use this option to build without
needing the extra fonts accepting you will get poor quality documents.
To build and install to a specific location: To build and install to a specific location:
$ ./waf configure --prefix=/foo/my/location $ ./waf configure --prefix=/foo/my/location

3
common/latex.py
View File

@ -107,7 +107,6 @@ def local_packages():
return packages return packages
def configure_tests(conf): def configure_tests(conf):
# #
# Using a hint from ita (thank you) : # Using a hint from ita (thank you) :
# https://github.com/waf-project/waf/blob/master/demos/tex/wscript # https://github.com/waf-project/waf/blob/master/demos/tex/wscript
@ -164,4 +163,6 @@ def configure_tests(conf):
if fails == 0: if fails == 0:
conf.env.RTEMSEXTRAFONTS = 'rtemsextrafonts.sty' conf.env.RTEMSEXTRAFONTS = 'rtemsextrafonts.sty'
else: else:
if not conf.options.disable_extra_fonts:
conf.fatal('Extra fonts not found, install or use --disable-extra-fonts')
conf.env.RTEMSEXTRAFONTS = 'rtemsextrafonts-null.sty' conf.env.RTEMSEXTRAFONTS = 'rtemsextrafonts-null.sty'

5
common/waf.py
View File

@ -203,7 +203,6 @@ def doc_pdf(ctx, source_dir, conf_dir):
quiet = True) quiet = True)
def doc_singlehtml(ctx, source_dir, conf_dir): def doc_singlehtml(ctx, source_dir, conf_dir):
# #
# Use a run command to handle stdout and stderr output from inliner. Using # Use a run command to handle stdout and stderr output from inliner. Using
# a standard rule in the build context locks up. # a standard rule in the build context locks up.
@ -283,6 +282,10 @@ def cmd_build(ctx, conf_dir = ".", source_dir = "."):
doc_html(ctx, source_dir, conf_dir) doc_html(ctx, source_dir, conf_dir)
def cmd_options(ctx): def cmd_options(ctx):
ctx.add_option('--disable-extra-fonts',
action = 'store_true',
default = False,
help = "Disable building with extra fonts for better quality (lower quality).")
ctx.add_option('--sphinx-verbose', ctx.add_option('--sphinx-verbose',
action = 'store', action = 'store',
default = "-Q", default = "-Q",