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

Use card previews in docs basics index #283

Merged
merged 2 commits into from
Nov 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/_static/basics/image-plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/basics/inspector-plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/basics/line-plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/basics/scatter3d-plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/basics/slicer-plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_static/basics/super-plot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 54 additions & 1 deletion docs/basics/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,61 @@
# Basic Usage

::::{grid} 3

:::{grid-item-card} Line plot
:link: line-plot.ipynb
:img-bottom: ../_static/basics/line-plot.png

:::

:::{grid-item-card} Image plot
:link: image-plot.ipynb
:img-bottom: ../_static/basics/image-plot.png

:::

::::{grid-item-card} Slicer plot
:link: slicer-plot.ipynb
:img-bottom: ../_static/basics/slicer-plot.png

:::

::::

::::{grid} 3

:::{grid-item-card} Inspector plot
:link: inspector-plot.ipynb
:img-bottom: ../_static/basics/inspector-plot.png

:::

:::{grid-item-card} Super-plot
:link: super-plot.ipynb
:img-bottom: ../_static/basics/super-plot.png

:::

:::{grid-item-card} Scatter 3D plot
:link: scatter3d-plot.ipynb
:img-bottom: ../_static/basics/scatter3d-plot.png

:::

::::
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a link to saving-figures is missing.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I didn't add it because I didn't have a good image for it.
As it's still in the left hand side menu, I thought it would be ok without it?

Also, if I want to have a card the same size as the other, I have to add two dummy/empty cards next to it.
I could of course just add a single card that spans the whole width?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would look like this
Screenshot at 2023-11-24 15-40-19

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would the dummy cards be visible?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I can force the number of columns
Screenshot at 2023-11-24 16-07-00

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok 👍


::::{grid} 3

:::{grid-item-card} {octicon}`download;1em` Saving figures to disk
:link: saving-figures.ipynb

:::

::::

```{toctree}
---
maxdepth: 2
hidden:
---

line-plot
Expand Down