More documentation and visualisation fixes #214
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The [just](https://github.com/casey/just) build command runner is "just" a better `make`, for our purposes. In particular, it properly terminates the documentation build if `setuptools-scm` is not installed. I'm sure there is a way to cast spells at `make` to make it do that, but why? Whenever there's a big .PHONY line in a Makefile, it means that `make` is probably the wrong tool. Also, the old Makefile I provided was only valid for GNU make (make portability is a bit gross). Also, `just` has binaries built for every major platform so installing is not a hassle.
This comment was marked as resolved.
This comment was marked as resolved.
Patol75
requested changes
Sep 23, 2024
adigitoleo
force-pushed
the
docs-touchup
branch
from
cd393ae
to
4ae97ef
Compare
Patol75
approved these changes
Sep 24, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a <200LOC cornerflow example to the docs website, with output (hopefully).
Fixes voigt averaging and tweaks the main 2D flow visualisation function so that colorbars work as in the paper.
Adds buttons to get to PyPI and GitHub to the docs landing page.
Migrates build tasks runner from make to just, which is just better, especially in our use case (spiel in the commit message of f17c6c2).