From 45a874957f57086cf11654ec92b77b5363b4d0ed Mon Sep 17 00:00:00 2001 From: Pavlo Shchelokovskyy Date: Tue, 11 Feb 2020 13:05:33 +0200 Subject: [PATCH 1/4] Test for issue 601 and font loading fallback sphinx conf.py set to use cover page and non-existing cover template, will fail to load the default fallback template (issue #601). also add two dummy non-font TTF files to fail some tests that are loading fonts from the input folder. This in fact is a bit random due to how os.walk/os.listdir works, (see https://docs.python.org/3/library/os.html#os.listdir). To maximize chances of failure one dummy ttf file name starts with 0, and another with Z (not an ideal and stable solution, but is the best I could quickly think of). --- rst2pdf/tests/input/000FailingFont.ttf | 0 rst2pdf/tests/input/ZZZFailingFont.ttf | 0 rst2pdf/tests/input/sphinx-issue601/conf.py | 231 ++++++++++++++++++ rst2pdf/tests/input/sphinx-issue601/index.rst | 3 + rst2pdf/tests/md5/sphinx-issue601.json | 9 + rst2pdf/tests/reference/sphinx-issue601.pdf | Bin 0 -> 6742 bytes 6 files changed, 243 insertions(+) create mode 100644 rst2pdf/tests/input/000FailingFont.ttf create mode 100644 rst2pdf/tests/input/ZZZFailingFont.ttf create mode 100644 rst2pdf/tests/input/sphinx-issue601/conf.py create mode 100644 rst2pdf/tests/input/sphinx-issue601/index.rst create mode 100644 rst2pdf/tests/md5/sphinx-issue601.json create mode 100644 rst2pdf/tests/reference/sphinx-issue601.pdf diff --git a/rst2pdf/tests/input/000FailingFont.ttf b/rst2pdf/tests/input/000FailingFont.ttf new file mode 100644 index 000000000..e69de29bb diff --git a/rst2pdf/tests/input/ZZZFailingFont.ttf b/rst2pdf/tests/input/ZZZFailingFont.ttf new file mode 100644 index 000000000..e69de29bb diff --git a/rst2pdf/tests/input/sphinx-issue601/conf.py b/rst2pdf/tests/input/sphinx-issue601/conf.py new file mode 100644 index 000000000..a8d484ebd --- /dev/null +++ b/rst2pdf/tests/input/sphinx-issue601/conf.py @@ -0,0 +1,231 @@ +# -*- coding: utf-8 -*- +# +# Sphinx markup documentation build configuration file, created by +# sphinx-quickstart on Tue Aug 18 22:54:33 2009. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.append(os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['rst2pdf.pdfbuilder'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'sphinx' +copyright = u'2009, RA' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = 'test' +# The full version, including alpha/beta/rc tags. +release = 'test' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of documents that shouldn't be included in the build. +#unused_docs = [] + +# List of directories, relative to source directory, that shouldn't be searched +# for source files. +exclude_trees = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +show_authors = True + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. Major themes that come with +# Sphinx are currently 'default' and 'sphinxdoc'. +html_theme = 'default' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_use_modindex = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = '' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'sphinx' + + +# -- Options for LaTeX output -------------------------------------------------- + +# The paper size ('letter' or 'a4'). +#latex_paper_size = 'letter' + +# The font size ('10pt', '11pt' or '12pt'). +#latex_font_size = '10pt' + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'sphinx.tex', u'sphinx Documentation', u'RA', 'manual'), + ('index2', 'sphinx2.tex', u'sphinx2 Documentation', u'RA', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# Additional stuff for the LaTeX preamble. +#latex_preamble = '' + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_use_modindex = True + +# -- Options for PDF output -------------------------------------------------- + +# Grouping the document tree into PDF files. List of tuples +# (source start file, target name, title, author). +pdf_documents = [ + ('index', u'MyProject1', u'My Project', u'Author Name') +] + +# A comma-separated list of custom stylesheets. Example: +pdf_stylesheets = ['sphinx'] + +# Create a compressed PDF +# Use True/False or 1/0 +# Example: compressed=True +#pdf_compressed=False + +# A colon-separated list of folders to search for fonts. Example: +# pdf_font_path=['/usr/share/fonts', '/usr/share/texmf-dist/fonts/'] + +# Language to be used for hyphenation support +pdf_language="en_US" + +# If false, no index is generated. +pdf_use_index = True + +# If false, no modindex is generated. +pdf_use_modindex = True + +# If false, no coverpage is generated. +pdf_use_coverpage = True +pdf_cover_template = "not-existing.tmpl" + +pdf_break_level = 1 + +pdf_verbosity=0 +pdf_invariant = True diff --git a/rst2pdf/tests/input/sphinx-issue601/index.rst b/rst2pdf/tests/input/sphinx-issue601/index.rst new file mode 100644 index 000000000..361b32816 --- /dev/null +++ b/rst2pdf/tests/input/sphinx-issue601/index.rst @@ -0,0 +1,3 @@ +:orphan: + +Lorem Ipsum diff --git a/rst2pdf/tests/md5/sphinx-issue601.json b/rst2pdf/tests/md5/sphinx-issue601.json new file mode 100644 index 000000000..925e9c23d --- /dev/null +++ b/rst2pdf/tests/md5/sphinx-issue601.json @@ -0,0 +1,9 @@ +bad_md5 = [ + 'sentinel' +] + +good_md5 = [ + '8e0093d3687e977827b719d4b7e22131', + 'sentinel' +] + diff --git a/rst2pdf/tests/reference/sphinx-issue601.pdf b/rst2pdf/tests/reference/sphinx-issue601.pdf new file mode 100644 index 0000000000000000000000000000000000000000..229f8723548ee0e1163a7d55c15e7a66b82b1211 GIT binary patch literal 6742 zcmeHL%}(P;5Wf2<>Vg(#H+Fa19or*>GyyV$Hn0%9+5^MEu{*&iu`{+az`nxHZSMQ5 zTV>~`6Ov(8;)3K5#df>8{;Rq^_AXDlEp9r--uG|+{0n_G&GNDr4&b9oRUVcq2Bd&E zi)Is*mT*^=)AyG3@bF;f740}2m{B${I55Zt_r~F&VRbnOeC&hO6=2hyadc#;G$sOi zvmoq*h3aO=*7~HzUsahzAy}trl*LIp0_(3N{g4*PYT+WBC}hgPx}FWnrzt)J_>0eU z!8gcD6GftbAga~L#_`X{6F(`>(c~SYD(J8RI3ovub*|zh>|~E{gU<}4FHPafHh2y< zJx7OcxKCnx*$j=n0gSstkZDyNd4$jiv5q)?z2}i0kzaG!8 zXK;%i0jr;t7){)61$mfOENR_ekH)e~g*+L=1 zT2*7rvZ~A|gGTB+i?J5|EYwAo;teeoi=3+KMz?P+X3%*wkghy4Svj&l{3 zNtT{a?(Cnu7Ysif|EkZgjQxV&1s(1Aygy5esfvk&m!qBHA8$*MwT z5KRC&LDkW?fM5vRF&zkca2gn2s+LNW4l@~-t_0VWCbNA9_u*^PgZkV5XqYxU7^d&| zOu+gj9~mjMDz&7*mg6`aYzDc4&O76Z*l-~oA575}t|P&;+sySGzQtJD2JSxuK0mAx{6hK_mN&BqT;_H7iXD_^NTeScY>+lA}H&%8VE zSL+TQ7UQxz?1)pHOc*5$2(}w+Iz8C$Wx1Nb*|eBV76I8E0#_5W-AH}xx|mI4(o)F-HGuugFB!l6f}(C3mRh0rPV(|$>z^LWhF5c8P3MtzLYFSMn! zB@AJ?=As$Zn{>Ix$%u_LAuypf)@=LvUTNdWy+P+Jwk4B^`7-*vgdbv3zV9wuXzS3uzG1dN+Q5f3~u^kQxg zBR>pdHf)EH7jegtzAK0J(aRLK#-4^vM%%GTs|9g_vkr~`yI{(JVOVGBFaw%*`UXzL zSqU^!;r(^;x1yw|j_NQkt27ZFLu|Bn`bXE;YoO8!iS2@B4OCjdK00UK9_-Vb=L+`G zvGw+BX`oUAl^UpoXZSV@*g&NQDy?wc_CdaZO7y?x1}ZgB2?62~1~yRXMX2;23x$n) literal 0 HcmV?d00001 From f1031743875d128de6190c3fe11765f807e43eb5 Mon Sep 17 00:00:00 2001 From: Pavlo Shchelokovskyy Date: Mon, 10 Feb 2020 18:24:06 +0200 Subject: [PATCH 2/4] Fix pdf cover fallback Fixes issue #601 seems this logging code line was copy-pasted from createpdf.py, and now fallback fails as it can not output log message as the object has no 'custom_resource' attribute --- rst2pdf/pdfbuilder.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rst2pdf/pdfbuilder.py b/rst2pdf/pdfbuilder.py index 87d90f981..51ba8a650 100644 --- a/rst2pdf/pdfbuilder.py +++ b/rst2pdf/pdfbuilder.py @@ -592,7 +592,7 @@ def add_template_path(path): try: template = jinja_env.get_template(self.config.pdf_cover_template) except jinja2.TemplateNotFound: - log.error("Can't find cover template %s, using default"%self.custom_cover) + log.error("Can't find cover template %s, using default"%self.config.pdf_cover_template) template = jinja_env.get_template('sphinxcover.tmpl') # This is what's used in the python docs because From 722ebc51a18d658682add3914d94553428a04e60 Mon Sep 17 00:00:00 2001 From: Pavlo Shchelokovskyy Date: Mon, 10 Feb 2020 18:30:25 +0200 Subject: [PATCH 3/4] Fix exception handling when loading fonts currently TTFError exceptions raised in loadFonts() result in UnboundLocalError: local variable 'font' referenced before assignment on the next line as the execution continues further. Just skip to next font after producing the warning log. --- rst2pdf/findfonts.py | 1 + 1 file changed, 1 insertion(+) diff --git a/rst2pdf/findfonts.py b/rst2pdf/findfonts.py index fcab09139..b1c18649b 100755 --- a/rst2pdf/findfonts.py +++ b/rst2pdf/findfonts.py @@ -79,6 +79,7 @@ def loadFonts(): font = TTFontFile(ttf) except TTFError: log.warning("Error processing %s", ttf) + continue family = make_string(font.familyName.lower()) fontName = make_string(font.name).lower() From 8525cd2d89a8ff8a54d85f240978ddbee6c60fc7 Mon Sep 17 00:00:00 2001 From: Rob Allen Date: Sat, 28 Mar 2020 15:06:13 +0000 Subject: [PATCH 4/4] Set the date on the cover page for the 601 test The generated PDF has to be consisted each time, so we set the date printed on the cover page to a specific date rather than using today's date. --- rst2pdf/tests/input/sphinx-issue601/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rst2pdf/tests/input/sphinx-issue601/conf.py b/rst2pdf/tests/input/sphinx-issue601/conf.py index a8d484ebd..90d678e91 100644 --- a/rst2pdf/tests/input/sphinx-issue601/conf.py +++ b/rst2pdf/tests/input/sphinx-issue601/conf.py @@ -55,7 +55,7 @@ # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -#today = '' +today = 'February 11, 2020' # Else, today_fmt is used as the format for a strftime call. #today_fmt = '%B %d, %Y'