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 Documenter and Revise from dependencies #70

Closed
fingolfin opened this issue Mar 6, 2024 · 6 comments
Closed

Remove Documenter and Revise from dependencies #70

fingolfin opened this issue Mar 6, 2024 · 6 comments

Comments

@fingolfin
Copy link
Contributor

Please remove both Documenter and Revise from Project.toml. Neither belongs in there.

I think we were there before, and they keep getting added due to the way you invoke julia. Please do not use

julia --project=.

or if you do, then at least make sure not to add packages there.

@fingolfin
Copy link
Contributor Author

That will also stop those CompatHelper PRs from being reopened automatically.... That is, you will fix the cause of that instead of constantly battling a symptom

@fingolfin
Copy link
Contributor Author

ping @blociss

@fingolfin fingolfin changed the title Remove Documenter Revise from dependencies Remove Documenter and Revise from dependencies Mar 6, 2024
@blociss
Copy link
Contributor

blociss commented Mar 6, 2024

Please remove both Documenter and Revise from Project.toml. Neither belongs in there.

I think we were there before, and they keep getting added due to the way you invoke julia. Please do not use

julia --project=.

or if you do, then at least make sure not to add packages there.

If I remove Documenter, then I can't verify my ```jldoctest block anymore.
I deactivated CompatHelper workflows

@fingolfin
Copy link
Contributor Author

Of course you can still verify jldoctest blocks -- those need Documenter, sure, but your package does not depend on Documenter.

That's what docs/Project.toml is for -- it declares the dependency Documenter, and on your package.

E.g. you can do this in the root of your package

julia --project=docs

then once in Julia, enter Pkg mode (by pressing ]) and do

dev .
up

then leave Pkg mode (by pressing backspace) and do whatever you do to run the doctests normally, e.g.

using GromovWitten, Documenter
doctest(GromovWitten)

@fingolfin
Copy link
Contributor Author

I would recommend
#71

The instructions in your README are really dangerous: suggesting to do julia --project is not a good idea, and are the source of this issue and the weird Pkg hackery you are doing in docs/make.jl. I'll make a PR to suggest a cleanup

@blociss
Copy link
Contributor

blociss commented Mar 7, 2024

I would recommend #71

The instructions in your README are really dangerous: suggesting to do julia --project is not a good idea, and are the source of this issue and the weird Pkg hackery you are doing in docs/make.jl. I'll make a PR to suggest a cleanup

Should I use this instead?
import Pkg; Pkg.activate(".")
import Pkg; Pkg.instantiate()
using GromovWitten

@blociss blociss closed this as completed Mar 8, 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

2 participants