Skip to content

Commit

Permalink
A few PDF improvements (#1527)
Browse files Browse the repository at this point in the history
Ref: #1342

1. Use the `oneside` option of the memoir class, which is better for reading on a screen and anything that isn't a bound book.
2. For now hardcode ToC depth to section.
3. Clear page after the title.

(cherry picked from commit f7c7929)
  • Loading branch information
mortenpi committed Feb 15, 2021
1 parent 027c92a commit 083f592
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

* ![Enhancement][badge-enhancement] `doctest()` no longer throws an error if cleaning up the temporary directory fails for some reason. ([#1513][github-1513], [#1526][github-1526])

* ![Enhancement][badge-enhancement] Cosmetic improvements to the PDF output. ([#1342][github-1342], [#1527][github-1527])

* ![Bugfix][badge-bugfix] Script-type doctests that have an empty output section no longer crash Documenter. ([#1510][github-1510])

* ![Bugfix][badge-bugfix] When checking for authentication keys when deploying, Documenter now more appropriately checks if the environment variables are non-empty, rather than just whether they are defined. ([#1511][github-1511])
Expand Down Expand Up @@ -694,6 +696,7 @@
[github-1337]: https://github.com/JuliaDocs/Documenter.jl/issues/1337
[github-1338]: https://github.com/JuliaDocs/Documenter.jl/issues/1338
[github-1339]: https://github.com/JuliaDocs/Documenter.jl/pull/1339
[github-1342]: https://github.com/JuliaDocs/Documenter.jl/issues/1342
[github-1344]: https://github.com/JuliaDocs/Documenter.jl/issues/1344
[github-1345]: https://github.com/JuliaDocs/Documenter.jl/pull/1345
[github-1349]: https://github.com/JuliaDocs/Documenter.jl/pull/1349
Expand Down Expand Up @@ -742,6 +745,7 @@
[github-1519]: https://github.com/JuliaDocs/Documenter.jl/pull/1519
[github-1520]: https://github.com/JuliaDocs/Documenter.jl/pull/1520
[github-1526]: https://github.com/JuliaDocs/Documenter.jl/pull/1526
[github-1527]: https://github.com/JuliaDocs/Documenter.jl/pull/1527

[julia-38079]: https://github.com/JuliaLang/julia/issues/38079

Expand Down
5 changes: 4 additions & 1 deletion src/Writers/LaTeXWriter.jl
Original file line number Diff line number Diff line change
Expand Up @@ -214,11 +214,13 @@ function writeheader(io::IO, doc::Documents.Document)
isfile(custom) ? cp(custom, "custom.sty"; force = true) : touch("custom.sty")
preamble =
"""
\\documentclass{memoir}
\\documentclass[oneside]{memoir}
\\usepackage{./documenter}
\\usepackage{./custom}
\\settocdepth{section}
\\title{
{\\HUGE $(doc.user.sitename)}\\\\
{\\Large $(get(ENV, "TRAVIS_TAG", ""))}
Expand All @@ -229,6 +231,7 @@ function writeheader(io::IO, doc::Documents.Document)
\\frontmatter
\\maketitle
\\clearpage
\\tableofcontents
\\mainmatter
Expand Down

0 comments on commit 083f592

Please sign in to comment.