Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove format in make.jl-generator #89

Closed
goerz opened this issue Feb 13, 2024 · 1 comment
Closed

Remove format in make.jl-generator #89

goerz opened this issue Feb 13, 2024 · 1 comment

Comments

@goerz
Copy link
Member

goerz commented Feb 13, 2024

Does the format still make sense, here?

function make(pkgname; format = :html)
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.

@goerz
Copy link
Member Author

goerz commented Feb 14, 2024

I agree with #90

@goerz goerz closed this as completed Feb 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant