From 9ede71c991ce47fc2bbf83654c8ec897b6bbff07 Mon Sep 17 00:00:00 2001 From: Philipp Wagner Date: Sat, 28 Mar 2020 18:09:52 +0000 Subject: [PATCH] Docs: Fix PDF build on ReadTheDocs ReadTheDocs switched from calling pdflatex directly to using latexmk. This change broke the previous workaround that only the last-built PDF file was made available on RTD. Use a more explicit approach instead to fix that. Changed upstream in readthedocs/readthedocs.org#5437 --- src/conf.py | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/src/conf.py b/src/conf.py index 9c587e5..09bcf02 100644 --- a/src/conf.py +++ b/src/conf.py @@ -149,21 +149,26 @@ # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('01_overview/index', 'osd-overview.tex', u'Open SoC Debug Overview', - u'The Open SoC Debug Contributors', 'manual'), - - ('02_spec/index', 'osd-spec.tex', u'Open SoC Debug Specification', - u'The Open SoC Debug Contributors', 'manual'), - - ('03_user/index', 'osd-userguide.tex', u'Open SoC Debug User Guides', - u'The Open SoC Debug Contributors', 'manual'), - - ('04_implementer/index', 'osd-implementerguide.tex', - u'Open SoC Debug Implementer Guides', - u'The Open SoC Debug Contributors', 'manual'), - - # The last document is the one and only one made available by RTD +latex_documents = [] +if not read_the_docs_build: + latex_documents += [ + ('01_overview/index', 'osd-overview.tex', u'Open SoC Debug Overview', + u'The Open SoC Debug Contributors', 'manual'), + + ('02_spec/index', 'osd-spec.tex', u'Open SoC Debug Specification', + u'The Open SoC Debug Contributors', 'manual'), + + ('03_user/index', 'osd-userguide.tex', u'Open SoC Debug User Guides', + u'The Open SoC Debug Contributors', 'manual'), + + ('04_implementer/index', 'osd-implementerguide.tex', + u'Open SoC Debug Implementer Guides', + u'The Open SoC Debug Contributors', 'manual'), + ] + +# ReadTheDocs only supports a single PDF document, make the combined doc +# available. +latex_documents += [ (master_doc, 'opensocdebug.tex', u'Open SoC Debug Documentation Library', u'The Open SoC Debug Contributors', 'manual'),