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

Error when passing format args positionally to makedocs #1046

Closed
mortenpi opened this issue Jun 28, 2019 · 0 comments · Fixed by #1061
Closed

Error when passing format args positionally to makedocs #1046

mortenpi opened this issue Jun 28, 2019 · 0 comments · Fixed by #1061
Milestone

Comments

@mortenpi
Copy link
Member

We shouldn't accept format objects (e.g. HTML(...) or LaTeX(...)) as positional arguments to makedocs. Currently you can pass them as a positional arguments (e.g. makedocs(LaTeX(), ...)) because they are <: Plugin. They won't have any effect though, since the output format is handled by the format keyword.

We should probably not declare HTML etc. to be <: Plugin in the first place. Instead perhaps a new abstract Writer type?

We are actually currently messing up in the test/example builds:

examples_html_local_doc = makedocs(
debug = true,
root = examples_root,
build = "builds/html-local",
doctestfilters = [r"Ptr{0x[0-9]+}"],
sitename = "Documenter example",
pages = htmlbuild_pages,
expandfirst = expandfirst,
linkcheck = true,
linkcheck_ignore = [r"(x|y).md", "z.md", r":func:.*"],
Documenter.HTML(
assets = ["assets/custom.css"],
prettyurls = false,
edit_branch = nothing,
),
)

@mortenpi mortenpi changed the title Error when pass format args positionally to makedocs Error when passing format args positionally to makedocs Jun 28, 2019
@mortenpi mortenpi added this to the 0.23.0 milestone Jul 7, 2019
mortenpi added a commit that referenced this issue Jul 8, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant