Conversation
|
IMPORTANT. I've disabled the experimental tutorial because I don't know how to fix it myself. Need to revive it before this is merged. Otherwise, I am making progress. @tjjarvinen do you understand this documentation error? I think it's this but not certain.
|
|
Doesn't this just mean there are new functions defined with doc strings and they should be listed in the docs. I think I had this happen somewhere else? (I might misremember...) |
|
It does seem that way, but we definitely don't mention all functions by name in the docs; instead there is some automatic feature that finds them. Why can't it find these? I need to remind myself of the details. |
| Reexport = "1" | ||
| StaticArrays = "1" | ||
| YAML = "0.4" | ||
| julia = "~1.10.0" |
There was a problem hiding this comment.
I thought the ~ means that we restrict to 1.10.x and don't allow 1.11. This was deliberate. Did I misunderstand something?
There was a problem hiding this comment.
Everything in this PR is up for discussion, no question. But this CI failure on nightly (which is running 1.12.0-DEV) was caused by the ~, as best I can tell, and I would prefer to always have the CI passing on main.
https://github.com/ACEsuit/ACEpotentials.jl/actions/runs/10500352832/job/29088598779
|
|
||
| [compat] | ||
| ACEpotentials = "0.6" | ||
| ACEpotentials = "0.8" |
There was a problem hiding this comment.
Should there even be a compact entry? Shouldn't the docs build just dev the "current" ACEpotentials?
There was a problem hiding this comment.
This is the line I get when building docs via CI:
[3b96b61c] + ACEpotentials v0.8.0-dev `~/work/ACEpotentials.jl/ACEpotentials.jl`
So the compat entry in the docs/Project folder is really not needed (and shouldn't be there)
| Pa2 = algebraic_smoothness_prior(model.basis; p=2) | ||
| Pa4 = algebraic_smoothness_prior(model.basis; p=4) | ||
| Pg = gaussian_smoothness_prior( model.basis, σl = (2/r_nn)^2, σn = (0.5/r_nn)^2); | ||
| Pa2 = ACEpotentials.algebraic_smoothness_prior(model.basis; p=2) |
There was a problem hiding this comment.
I think this is wrong. It should be ACE1x.algebratic_smoothness_prior etc .... But we are almost ready to get rid of ACE1 and ACE1x entirely so I'm not sure it's worth working on this right now.
There was a problem hiding this comment.
Not sure, I chose ACEpotentials because of this
I don't mind changing to ACE1x if that's better, but at minimum the change I made allows that part of the docs to build successfully, where it failed before.
I don't care about this example specifically, but I want to fix the unimportant CI failures so that more impactful things don't get lost.
|
Closing, replaced by #229. |
2 participants
See #226. I'm creating this PR to trigger the CI. I won't merge without confirmation from someone.