In 2021, I created the package GitHub - NicolasL-S/SpeedMapping.jl: General fixed point mapping acceleration and optimization in Julia
I finally got some time to update it. I created a branch “MajorRefactor” to make all the changes and successfully deployed the documentation on Introduction · SpeedMapping.jl. Earlier today, I merged MajorRefactor back on main, hoping that deploying the documentation on Home · SpeedMapping.jl would be as easy as it was on dev. Yet, no matter my efforts, nothing seems to work. What’s worse, after trying many different things, including creating a package new version, both the stable and dev have disappeared. The puzzling part is that I hardly get any error message while building the doc. Help would be greatly appreciated!
after Delete Documentation.yml · NicolasL-S/SpeedMapping.jl@c15c0d1 · GitHub there’s no CI building docs at all?
building & deploy docs should be really simple now.
Follow this Hosting Documentation · Documenter.jl
Thanks a lot for your help. Yes, build actions were missing; I had tried many things and after the last, I forgot to put them back.
Now I think something is very wrong with the repo. In pages, I see this:
but my actions are set to Allow all actions and reusable workflows. I opened a ticket on Github’s support, but they said I needed a paid GitHub plan, Copilot Business, or Copilot Enterprise, which I obviously don’t.
In the end, the only way I saw to fix the problem was to create a new repo just to deploy the docs:
https://nicolasl-s.github.io/SpeedMappingDeployDoc.jl/dev/
Now I’m ready to register the new version of SpeedMapping.jl on JuliaHub. I’m just wondering whether this use of another repo to host the docs can lead to confusion with the JuliaRegistrator. I think I could probably get SpeedMappingDeployDoc.jl to deploy the docs on SpeedMapping.jl if necessary. But I’d like to avoid doing any more changes now that things seem to be working.
In principle that should be fine to have another repository to host the docs. However, the feedback from GiHub support sounds a bit strange. You actions do work (unless the screenshot is from a private repository, there things are different!)
Your docs on the Main repo seem to work fine and commit new docs to the gh-pages branch, see GitHub - NicolasL-S/SpeedMapping.jl at gh-pages, so in order to not work double and render docs in multiple places try the following step
And also, if you happen to be employed at a university, you can actually get the smallest plan for free as well.
And sure, if you feel you are tired in twiddling with all that, the separate repo should be fine as well, just add the correct link in your readme to the rendered docs. But then maybe also remove the action on the original repo again to not let that one render without being needed.
addon: For example GitHub - bifurcationkit/BifurcationKit.jl: A Julia package to perform Bifurcation Analysis has a separate repo for its docs, see GitHub - bifurcationkit/BifurcationKitDocs.jl: Documentation for BifurcationKit.jl. So I would say that is a bit uncommon, but can be done.