Use toml in shortcodes

[jarrodmillman]

While working on the grid of cards (i.e., embedded shortcodes), we ran into issue using yaml (see #468)

We should replace yamltotables (see #7 and #11). We should probably make a release with tomltotables, convert all the sites to use it, and remove yamltotables in the next release.

We may also want to use more toml in shortcodes as we make more complicated shortcodes.

[alphapapa]

@jarrodmillman Please see below my current plan for this issue and let me know if I've missed anything. Will be starting on the items presently. Thanks.

• Plan: How to proceed.

  • In scientific-python-hugo-theme: The theme repo itself.

    • Replace yamlToTables shortcode with a tomlToTables one: Add tomlToTable by stefanv · Pull Request #548 · scientific-python/scientific-python-hugo-theme · GitHub
      • Figure out what I need to do about that PR.
    • Add tomlToTables shortcode.
    • Release theme version including tomlToTables.
    • Remove yamlToTables.
    • Find other shortcodes that may include YAML and consider switching them to TOML.
    • Consider documenting the preference for TOML over YAML.

  • On other sites: Sites that use scientific-python-hugo-theme.

    • On each site:
      • Upgrade theme to version of scientific-python-hugo-theme that includes tomlToTable.
      • Replace instances of yamlToTable with tomlToTable.
      • Find instances of other shortcodes that may include YAML and switch them to TOML.
      • Push PR making those changes.
        • Tag reviewers as appropriate.
      • Ensure PR is merged.

• Questions: What else do I need to know?

  • Capitalization: Is it yamlToTable or yamltotable? Same for the TOML version.

• References: Relevant resources.

  • Adding tomlToTable shortcode (draft): Add tomlToTable by stefanv · Pull Request #548 · scientific-python/scientific-python-hugo-theme · GitHub

  • Changing card shortcodes to use TOML: Use toml for card data by jarrodmillman · Pull Request #468 · scientific-python/scientific-python-hugo-theme · GitHub

  • yamlToTable shortcode added (2021): Add yamlToTable shortcode by stefanv · Pull Request #7 · scientific-python/scientific-python-hugo-theme · GitHub

    • yamlToTable: add row/column span by stefanv · Pull Request #11 · scientific-python/scientific-python-hugo-theme · GitHub

[jarrodmillman]

I can take care of tomltotable and removing yamltotable. It would be worth reviewing if there are other places that would benefit from using toml, but it isn't a priority. I will keep this open as more of a meta-issue for now.