Skip to content

Commit 9ede71c

Browse files
committed
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
1 parent c565ae8 commit 9ede71c

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

src/conf.py

+20-15
Original file line numberDiff line numberDiff line change
@@ -149,21 +149,26 @@
149149
# Grouping the document tree into LaTeX files. List of tuples
150150
# (source start file, target name, title,
151151
# author, documentclass [howto, manual, or own class]).
152-
latex_documents = [
153-
('01_overview/index', 'osd-overview.tex', u'Open SoC Debug Overview',
154-
u'The Open SoC Debug Contributors', 'manual'),
155-
156-
('02_spec/index', 'osd-spec.tex', u'Open SoC Debug Specification',
157-
u'The Open SoC Debug Contributors', 'manual'),
158-
159-
('03_user/index', 'osd-userguide.tex', u'Open SoC Debug User Guides',
160-
u'The Open SoC Debug Contributors', 'manual'),
161-
162-
('04_implementer/index', 'osd-implementerguide.tex',
163-
u'Open SoC Debug Implementer Guides',
164-
u'The Open SoC Debug Contributors', 'manual'),
165-
166-
# The last document is the one and only one made available by RTD
152+
latex_documents = []
153+
if not read_the_docs_build:
154+
latex_documents += [
155+
('01_overview/index', 'osd-overview.tex', u'Open SoC Debug Overview',
156+
u'The Open SoC Debug Contributors', 'manual'),
157+
158+
('02_spec/index', 'osd-spec.tex', u'Open SoC Debug Specification',
159+
u'The Open SoC Debug Contributors', 'manual'),
160+
161+
('03_user/index', 'osd-userguide.tex', u'Open SoC Debug User Guides',
162+
u'The Open SoC Debug Contributors', 'manual'),
163+
164+
('04_implementer/index', 'osd-implementerguide.tex',
165+
u'Open SoC Debug Implementer Guides',
166+
u'The Open SoC Debug Contributors', 'manual'),
167+
]
168+
169+
# ReadTheDocs only supports a single PDF document, make the combined doc
170+
# available.
171+
latex_documents += [
167172
(master_doc, 'opensocdebug.tex',
168173
u'Open SoC Debug Documentation Library',
169174
u'The Open SoC Debug Contributors', 'manual'),

0 commit comments

Comments
 (0)