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

Deploy docs to separate repo #233

Open
kbarros opened this issue Feb 4, 2024 · 2 comments
Open

Deploy docs to separate repo #233

kbarros opened this issue Feb 4, 2024 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@kbarros
Copy link
Member

kbarros commented Feb 4, 2024

Our docs images are high res and quite large. Hosting docs for all releases will be quite large -- I could imagine this growing to ~ GB, which will slow down clones of Sunny. We could follow Meshes.jl and create a separate repo to store the gh-pages for docs deployment:
https://github.com/JuliaGeometry/Meshes.jl/blob/master/docs/make.jl

@kbarros kbarros added the help wanted Extra attention is needed label Feb 23, 2024
@kbarros
Copy link
Member Author

kbarros commented May 18, 2024

This is now described in the Documenter docs: https://documenter.juliadocs.org/stable/man/hosting/#Out-of-repo-deployment

@kbarros
Copy link
Member Author

kbarros commented Nov 14, 2024

Some more motivation. As of Sunny 0.7.3, cloning the main branch only requires 8.2 MB of space:

git clone --single-branch -b main [email protected]:SunnySuite/Sunny.jl.git
du -sh Sunny.jl
# 8.2M	Sunny.jl

A full clone downloads the documentation contained in the gh-pages branch, which includes many Sunny releases. This takes 131 MB of space:

git clone [email protected]:SunnySuite/Sunny.jl.git
du -sh Sunny.jl
# 131M	Sunny.jl

Note that the docs are still in compressed form. Checking out gh-pages will decompress them into of 326 MB data:

cd Sunny.jl
git checkout gh-pages
du -sh .
# 326M	.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant