search

FJRubio67 / HazReg.jl

Parametric hazard-based regression models (Julia package)
MIT License
5 stars 2 forks source link

Configure the repo for online docs #6

Closed lrnv closed 5 months ago

lrnv commented 5 months ago

Hey,

This is something that only you can do to solve the faillure from https://github.com/FJRubio67/HazReg.jl/actions/runs/8308294730/job/22738389978

You have to follow this guide to setup documenter correctly : https://m3g.github.io/JuliaNotes.jl/stable/publish_docs/

In particular, I think you have to use DocumenterTools to generates secret keys and add them to the repo so that the automatic compilation of the documentation can push to github pages. Tell me if that is not clear enough :)

FJRubio67 commented 5 months ago

@lrnv I have followed the first two steps using the DocumenterTools and generating the SSH key. I am not sure if this solves the issue, so, let me know if I missed something.

lrnv commented 5 months ago

You created a weird Project.toml with my local version of the package in its name... I think there is still something not working correctly with the docs project.toml

Look at another package to see how it looks in term of the dependency to the package itself in the docs/Project.toml and try to fix it by hand.

lrnv commented 5 months ago

But it does not look like this is the problem however... I think we should ask on discourse about the observed error on CI.

FJRubio67 commented 5 months ago

@lrnv I will have a look as soon as I can, but it will probably have to wait until April.

lrnv commented 5 months ago

I asked for help there https://discourse.julialang.org/t/documenter-jl-failling-to-push-im-a-bit-lost/111777

lrnv commented 5 months ago

See krastonov answer there, maybe that'll be enough. it's hard to diagnose without ownership ^^

FJRubio67 commented 5 months ago

@lrnv "Read and write permissions" are now enabled. I am not sure I understand the second part ("proper solution") in the link.

lrnv commented 5 months ago

Try to commit something ? E.g. remove that ugly folder under docs ?

lrnv commented 5 months ago

Looks like it worked and everything got pushed to the GitHub pages branch. Maybe you have to configure the GitHub repo to publish it's website from this new branch, once again I thought it'll be automatical but maybe it is not

lrnv commented 5 months ago

Haaaa found it ! It is trying to find the /docs folder while there is none. In your settings, under the Page tab on the left, you should put :

image

Your's should show /docs instead of / (root): change it to / (root).

lrnv commented 5 months ago

Looks like here : https://github.com/FJRubio67/HazReg.jl/actions/runs/8332140704/job/22800603515#step:4:3 that it is still on "/docs". Can you screen shot this part of your settings for me ?

FJRubio67 commented 5 months ago

I created a new release to properly trigger the CI. It has now passed all checks. I will check your comments in a minute.

lrnv commented 5 months ago

The release was not needed (you'll get dev docs without it, but it's enough for the moment). But this comment (put Jekyll on root instead of docs) is necessary for it to work correctly (i think).

FJRubio67 commented 5 months ago

The documentation seems to be working now ... https://fjrubio67.github.io/HazReg.jl/stable/

lrnv commented 5 months ago

It worked ! You can see the docs there : https://fjrubio67.github.io/HazReg.jl/ :)

So there you can see your articles that I ported to this syntax -- not very hard to do it's suite similar. These pages will be automatically updated on each commit to master (on the dev documentation) and on each release ( on the stable documentation).

From this, we now have graphs and stuff to validate the outputs of the package as we modify it.

Thanks, now I can get back to the drastic code simplification I had at the begining, while being certain that I do not breaker everything :)