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

Add a plugins keyword argument for doctests (and makedocs) #2245

Closed
goerz opened this issue Sep 6, 2023 · 3 comments · Fixed by #2249
Closed

Add a plugins keyword argument for doctests (and makedocs) #2245

goerz opened this issue Sep 6, 2023 · 3 comments · Fixed by #2249

Comments

@goerz
Copy link
Member

goerz commented Sep 6, 2023

From JuliaDocs/DocumenterCitations.jl#34, downstream from CliMA/ClimaAtmos.jl#2068

At least in principle, it would be conceivable that a Documenter plugin could do something that would affect doctests. It would be good if there was some way to pass plugins to the doctest function.

As a matter of fact (since there's a breaking 1.0 release coming), it might be worth reconsidering how Documenter handles plugins in general. The way plugins are passed as positional arguments is undocumented, see #2113. Maybe it would be better to have a plugins keyword argument for both makedocs and doctests?

@mortenpi
Copy link
Member

mortenpi commented Sep 6, 2023

Yeah, I would be okay with changing the positional argument to a keyword in makedocs. The positional arguments are a bit out of place considering that everything else is done via keywords. And yes, I think doctest should also take that keyword.

@goerz
Copy link
Member Author

goerz commented Sep 6, 2023

Great, I'll take a stab at it maybe this weekend

@goerz
Copy link
Member Author

goerz commented Sep 10, 2023

Done, see #2249

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.

2 participants