Skip to content

Add myst-nb cell tags as needed in docs #2768

Description

@VeckoTheGecko

What version of Parcels are you running?

main

Is your feature request related to a problem?

Currently notebooks and doc pages show cell inputs and outputs in their entirety. There are cases where we don't want this:

  • Plotting code - we would want to use a hide-input cell tag to put the cell inputs in a collapsable block
  • Code for cleaning up .parquet temporary files - we would want to use remove-input and remove-output cell tags to completely hide these cells

This can be controlled via myst-nb cell tags, and gives us more control over what we draw attention to in our documentation.

Describe the solution you'd like

Applying of cell tags appropriately. Note generally that when working with myst formatting the web browser version of jupyter lab (i.e., via the jupyter lab local server) is better as it shows rich previews, compared to the vscode version of Jupyter which doesn't support myst.

Describe alternatives you've considered

No response

Additional context

No response

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status
    Backlog

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions