Skip to content

Commit

Permalink
Give up on multiple readthedocs PDFs
Browse files Browse the repository at this point in the history
It doesn't appear possible to adapt the readthedocs build process to
generate multiple PDFs
(readthedocs/readthedocs.org#2045).
Instead, build Getting Started and Walkthough files locally and serve
them from doc/_static.
  • Loading branch information
tsj5 committed May 15, 2020
1 parent 1f2dd1e commit 8eaf163
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 21 deletions.
Binary file added doc/_static/MDTF_getting_started.pdf
Binary file not shown.
Binary file added doc/_static/MDTF_walkthrough.pdf
Binary file not shown.
11 changes: 5 additions & 6 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,9 @@
#
html_theme_options = {
'extra_nav_links' : {
"Getting Started (PDF)": "https://buildmedia.readthedocs.org/media/pdf/MDTF-diagnostics/latest/MDTF_getting_started.pdf",
"Developer's Walkthough (PDF)": "https://buildmedia.readthedocs.org/media/pdf/MDTF-diagnostics/latest/MDTF_walkthrough.pdf",
"Full documentation (PDF)": "https://buildmedia.readthedocs.org/media/pdf/MDTF-diagnostics/latest/mdtf-diagnostics.pdf"
"Getting Started (PDF)": "https://mdtf-diagnostics.readthedocs.io/en/latest/_static/MDTF_getting_started.pdf",
"Developer's Walkthough (PDF)": "https://mdtf-diagnostics.readthedocs.io/en/latest/_static/MDTF_walkthrough.pdf",
"Full documentation (PDF)": "https://mdtf-diagnostics.readthedocs.io/_/downloads/en/latest/pdf/"
}
}

Expand Down Expand Up @@ -177,13 +177,13 @@
u'MDTF Diagnostics Documentation', author, 'manual'
),
(
'tex_getting_started', 'MDTF_getting_started.tex_',
'tex_getting_started', 'MDTF_getting_started.tex',
u"MDTF Getting Started Guide",
r"Thomas Jackson (GFDL), Yi-Hung Kuo (UCLA), Dani Coleman (NCAR)",
'sphinxmdtfhowto'
),
(
'tex_walkthrough', 'MDTF_walkthrough.tex_',
'tex_walkthrough', 'MDTF_walkthrough.tex',
u"MDTF Developer's Walkthrough",
(
r"Yi-Hung Kuo\textsuperscript{a} \and Dani Coleman\textsuperscript{b} "
Expand All @@ -197,7 +197,6 @@
]

latex_additional_files = [
'latex/latexmkrc',
'latex/sphinxmdtfhowto.cls'
]

Expand Down
15 changes: 0 additions & 15 deletions doc/latex/latexmkrc

This file was deleted.

0 comments on commit 8eaf163

Please sign in to comment.