-
Notifications
You must be signed in to change notification settings - Fork 29
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
Run examples and produce output with every Docs built #345
Conversation
@mortenpi thanks for helping out on Slack for this and pointing out the Now UnicodePlots works but there are some strange white horizontal lines... E.g., see how this plot looks like in the docs preview Any idea what's happening here? |
We apply 1.5 line height. If I disable that, it looks like this .. which is great, but it makes normal text output look awful I don't really have a good solution here though, since there is no way to automatically distinguish these two cases, to apply different CSS to them. Might be worth an issue over at Documenter though. |
Though, if you don't mind that look for the text blocks, you could apply custom CSS here that overrides the |
oh I see... gotcha... |
This is awesome, thanks folks! Another related issue is that some terminals use fewer colours than others. iTerm2 (similar VSCode) left and macos Terminal right I haven't understood why that is, how to switch been one and the other, or whether it's easy to get the more colours into the Documenter easily - but this would be awesome 😍 |
Update README.md with logo
Fix typos in docs
…dyWeather.jl into ss/vertical_upwinding
Different vertical advection schemes
Bugfix in vertical advection
Primitive equation documentation
Speedstring precompilation warning
(sorry for merging main in here) @navidcy while the docs build, there is the following error which means that PyPlot figures are not produced and included in the docs. Locally this works fine for me though!
I guess you are using CairoMakie for Oceananigans? |
@navidcy I think I got it working by replacing PyPlot with PythonPlot... @simone-silvestri and I have been trying to use SixelTerm, which actually works too!! I currently just can't get it to work with PyPlot/PythonPlot but Plots.jl works fine - I'm just not as used to that interface. |
This PR makes code examples in docs run every time the docs are built and, this way, it ensures that the code and output are always current with latest code version.
(Follow up from a discussion in #344.)