The use case I imagine here is where you want to move the docs from one domain to another (e.g. when you move the package from one GitHub org to another), but you want to keep the old URLs working(-ish).
The normal process is to just move the gh-pages to the new repo. With this function, you can replace the old site with redirects to the new site.
E.g. let's say you want to move from a github.com/personalusername/MyPackage.jl (docs hosted at https://personalusername.github.io/MyPackage.jl/) to github.com/CentralizedJuliaOrg/MyPackage.jl (with docs hosted at https://centralizedjulia.org/MyPackage.jl.
To do that, you can check out the gh-pages branch locally and run:
The contents of out should be pushed to the old repository (i.e. personalusername), and then https://personalusername.github.io/MyPackage.jl/... should redirect to the new domain.
Currently builds on top of #75. Needs tests and docs.
The use case I imagine here is where you want to move the docs from one domain to another (e.g. when you move the package from one GitHub org to another), but you want to keep the old URLs working(-ish).
The normal process is to just move the
gh-pages
to the new repo. With this function, you can replace the old site with redirects to the new site.E.g. let's say you want to move from a
github.com/personalusername/MyPackage.jl
(docs hosted athttps://personalusername.github.io/MyPackage.jl/
) togithub.com/CentralizedJuliaOrg/MyPackage.jl
(with docs hosted athttps://centralizedjulia.org/MyPackage.jl
.To do that, you can check out the
gh-pages
branch locally and run:The contents of
out
should be pushed to the old repository (i.e. personalusername), and thenhttps://personalusername.github.io/MyPackage.jl/...
should redirect to the new domain.Currently builds on top of #75. Needs tests and docs.