You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fmtpkg = format ===:markdown?", DocumenterMarkdown":
format ===:pdf?", DocumenterLaTeX":""
fmtstr = format ===:html?"Documenter.HTML()":
format ===:markdown?"Markdown()":
format ===:pdf?"LaTeX()":""
sitename = format !==:markdown?"\n sitename = \"$(pkgname)\",":""
As far as I know, DocumenterMarkdown didn't really make the transition to Documenter 1.0, so should we just remove it here (as well as anything else related to mkdocs)
Even if we wanted to keep mkdocs support: I'm not sure the way format is used here is very useful. E.g., with format=:pdf, it would generate (overwrite!) a make.jl file to only have a LaTeX() configuration. My intuition would be that Documenter pretty much always has an HTML() configuration, and then maybe a LaTeX() configuration in addition. I'd expect anything beyond HTML() a pretty special use case that people should set up "by hand", not something that the generator for a default make.jl would take into account.
So, I would recommend just removing the format option, and always generating a make.jl file with an HTML() configuration.
The text was updated successfully, but these errors were encountered:
Does the
format
still make sense, here?DocumenterTools.jl/src/Generator.jl
Lines 30 to 37 in 5306737
As far as I know,
DocumenterMarkdown
didn't really make the transition to Documenter 1.0, so should we just remove it here (as well as anything else related tomkdocs
)Even if we wanted to keep
mkdocs
support: I'm not sure the wayformat
is used here is very useful. E.g., withformat=:pdf
, it would generate (overwrite!) amake.jl
file to only have aLaTeX()
configuration. My intuition would be thatDocumenter
pretty much always has anHTML()
configuration, and then maybe aLaTeX()
configuration in addition. I'd expect anything beyondHTML()
a pretty special use case that people should set up "by hand", not something that the generator for a defaultmake.jl
would take into account.So, I would recommend just removing the
format
option, and always generating amake.jl
file with anHTML()
configuration.The text was updated successfully, but these errors were encountered: