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

Documentation build performance #274

Open
jamesgardner1421 opened this issue Apr 27, 2022 · 0 comments
Open

Documentation build performance #274

jamesgardner1421 opened this issue Apr 27, 2022 · 0 comments

Comments

@jamesgardner1421
Copy link
Member

Currently the documentation build takes more than 30 minutes on GitHub, and although faster locally, it can be quite annoying to update just because it takes so long to build. Other packages don't appear to have this problem so it is worth trying to figure out if this can be improved.

Possible options include:

  • Splitting subpackage documentation (NQCModels.jl, CubeLDFAModel.jl). However, this might make it slightly harder to find stuff if it's all split up.
  • Remove some extra docs dependencies. For example, we don't need to use both Plots and Makie to generate the plots, picking just one would help.
  • Shorten some of the examples. Some of the ensemble simulations take a non-negligible amount of time to run and these add up. We could also consider caching the plots and not running the code at all though things might break without us realising.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant