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

Using development version of Documenter.jl will pull old release of DocumenterTools #79

Closed
frankier opened this issue Sep 5, 2023 · 2 comments

Comments

@frankier
Copy link

frankier commented Sep 5, 2023

It looks like DocumenterTools.jl 0.1.2 did not require Documenter. What this means is that if we attempt to add DocumenterTools alongside a development release of Documenter (which has had its version incremented to 0.28), the newest version of this package is not installed, and instead 0.1.2 is.

This is the case when I try to build the Documenter docs locally.

One possible fix would be to not increment Documenter.jl version numbers until a release is made. I'm not sure about the pros and cons of this, but I believe this is the version incrementing pattern I have come across most frequently in the Julia ecosystem.

I have currently worked around it by using dev to install a local working copy of this repo with 0.28 added to its compat bounds.

@frankier frankier changed the title Using development version of Documenter.jl will pull old release Using development version of Documenter.jl will pull old release of DocumenterTools Sep 5, 2023
@mortenpi
Copy link
Member

mortenpi commented Sep 5, 2023

If you run the ./docs/instantiate.jl script, it will instantiate the correct environment. I've created special tags that are compatible with Documenter#master: https://github.com/JuliaDocs/DocumenterTools.jl/tree/documenter-v0.1.17+0.28.0-DEV

That said, it would be good to have a better system here. But I'd say the fundamental problem is the circular dependency between Documenter and DocumenterTools. But FWIW, I think once Documenter 1.0 is out, we'll set the compat bound here to Documenter = "1", and then we won't run into this issue until Documenter 2.0 (which will likely be some ways away).

@frankier
Copy link
Author

All makes sense. I think I'll close this since there's nothing to action here.

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

2 participants