Some more docs for latex output. (#911)

JuliaDocs · Dec 10, 2018 · 1fdd03e · 1fdd03e
1 parent 5a29390
commit 1fdd03e
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/docs/src/man/other-formats.md b/docs/src/man/other-formats.md
@@ -158,8 +158,11 @@ using DocumenterLaTeX
 
 When `DocumenterLaTeX` is loaded, you can set `format = LaTeX()` in [`makedocs`](@ref),
 and Documenter will generate a PDF version of the documentation using LaTeX.
-You should also specify the `sitename` and `authors` keywords for `makedocs` when using the
-LaTeX output.
+The `makedocs` argument `sitename` will be used for the `\\title` field in the tex document,
+and if the build is for a release tag (i.e. when the `"TRAVIS_TAG"` environment variable is set)
+the version number will be appended to the title.
+The `makedocs` argument `authors` should also be specified, it will be used for the
+`\\authors` field in the tex document.
 
 ### Compiling using natively installed latex
 

diff --git a/src/Writers/LaTeXWriter.jl b/src/Writers/LaTeXWriter.jl
@@ -18,7 +18,20 @@ import ...Documenter: Documenter
 """
  LaTeXWriter.LaTeX(; kwargs...)
 
-Sets the behavior of [`LaTeXWriter`](@ref).
+Output format specifier that results in LaTeX/PDF output.
+Used together with [`makedocs`](@ref), e.g.
+
+```julia
+makedocs(
+ format = LaTeX()
+)
+```
+
+The `makedocs` argument `sitename` will be used for the `\\title` field in the tex document,
+and if the build is for a release tag (i.e. when the `"TRAVIS_TAG"` environment variable is set)
+the version number will be appended to the title.
+The `makedocs` argument `authors` should also be specified, it will be used for the
+`\\authors` field in the tex document.
 
 # Keyword arguments