Skip to content

Commit a1206db

Browse files
committed
Add cards to usage landing pages (#97)
# Description Adds cards to landing pages under the usage section. Organization, wording and the order of the cards can be changed according to the review. ## Type of change - [x] Fixes or improves existing content # References Closes #87 ## Final checklist: - [x] My PR is the minimum possible work for the desired functionality
1 parent d21a63e commit a1206db

File tree

11 files changed

+154
-12
lines changed

11 files changed

+154
-12
lines changed

.circleci/config.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# Use the latest 2.1 version of CircleCI pipeline process engine.
2+
# See: https://circleci.com/docs/2.0/configuration-reference
3+
version: 2.1
4+
5+
# Orbs are reusable packages of CircleCI configuration that you may share across projects, enabling you to create encapsulated, parameterized commands, jobs, and executors that can be used across multiple projects.
6+
# See: https://circleci.com/docs/2.0/orb-intro/
7+
orbs:
8+
# The python orb contains a set of prepackaged CircleCI configuration you can use repeatedly in your configuration files
9+
# Orb commands and jobs help you with common scripting around a language/tool
10+
# so you dont have to copy and paste it everywhere.
11+
# See the orb documentation here: https://circleci.com/developer/orbs/orb/circleci/python
12+
python: circleci/python@1.5.0
13+
14+
# Define a job to be invoked later in a workflow.
15+
# See: https://circleci.com/docs/2.0/configuration-reference/#jobs
16+
jobs:
17+
build-docs: # This is the name of the job, feel free to change it to better match what you're trying to do!
18+
# These next lines defines a Docker executors: https://circleci.com/docs/2.0/executor-types/
19+
# You can specify an image from Dockerhub or use one of the convenience images from CircleCI's Developer Hub
20+
# A list of available CircleCI Docker convenience images are available here: https://circleci.com/developer/images/image/cimg/python
21+
# The executor is the environment in which the steps below will be executed - below will use a python 3.10.2 container
22+
# Change the version below to your required version of python
23+
docker:
24+
- image: cimg/python:3.10.2
25+
# Checkout the code as the first step. This is a dedicated CircleCI step.
26+
# The python orb's install-packages step will install the dependencies from a Pipfile via Pipenv by default.
27+
# Here we're making sure we use just use the system-wide pip. By default it uses the project root's requirements.txt.
28+
# Then run your tests!
29+
# CircleCI will report the results back to your VCS provider.
30+
steps:
31+
- checkout
32+
- run:
33+
name: Install qt libs + xvfb
34+
command: sudo apt-get update && sudo apt-get install -y xvfb libegl1 libdbus-1-3 libxkbcommon-x11-0 libxcb-icccm4 libxcb-image0 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-xinerama0 libxcb-xinput0 libxcb-xfixes0 x11-utils
35+
36+
- run:
37+
name: Install python dependencies
38+
# app-dir: ~/project/package-directory/ # If you're requirements.txt isn't in the root directory.
39+
command: |
40+
python -m venv venv
41+
. venv/bin/activate
42+
python -m pip install --upgrade pip
43+
python -m pip install -r requirements.txt
44+
- run:
45+
name: Clone main repo
46+
command: git clone git@github.com:napari/napari.git napari
47+
- run:
48+
name: Install napari-dev
49+
command: |
50+
. venv/bin/activate
51+
python -m pip install -e napari/".[pyqt,dev]"
52+
- run:
53+
name: Build docs
54+
command: |
55+
. venv/bin/activate
56+
xvfb-run --auto-servernum make docs-build GALLERY_PATH=../napari/examples/
57+
58+
# Invoke jobs via workflows
59+
# See: https://circleci.com/docs/2.0/configuration-reference/#workflows
60+
workflows:
61+
sample: # This is the name of the workflow, feel free to change it to better match your workflow.
62+
# Inside the workflow, you define the jobs you want to run.
63+
jobs:
64+
- build-docs

.gitpod.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# This configuration file was automatically generated by Gitpod.
2+
# Please adjust to your needs (see https://www.gitpod.io/docs/introduction/learn-gitpod/gitpod-yaml)
3+
# and commit this file to your remote git repository to share the goodness with others.
4+
5+
# Learn more from ready-to-use templates: https://www.gitpod.io/docs/introduction/getting-started/quickstart
6+
7+
tasks:
8+
- init: make
9+
10+

docs/guides/layers.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(layers-glance)=
12
# Layers at a glance
23

34
[Layers](napari.layers) are the basic viewable objects that can be added to a

docs/tutorials/annotation/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1+
(annotation)=
12
# Annotation
23

3-
This section contains tutorials showing how to annoate images and videos using the napari points, labels, or shapes layers.
4+
This section contains tutorials showing how to annotate images and videos using the napari points, labels, or shapes layers.
45

56
* [Annotating videos with napari](annotate_points)

docs/tutorials/fundamentals/getting_started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(getting-started)=
12
# Getting started with napari
23

34
Welcome to the getting started with **napari** tutorial!

docs/tutorials/fundamentals/viewer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ kernelspec:
1111
name: python3
1212
---
1313

14+
(viewer-tutorial)=
1415
# napari viewer tutorial
1516

1617
+++

docs/tutorials/index.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,38 @@ These tutorials will help you explore the main usage modes and methods of
55
napari, and target people who want to use napari. If you are also interested
66
in contributing to napari then please check out [the Community page](../community/index).
77

8+
::::{grid}
9+
:::{grid-item-card} Annotation
10+
:link: annotation
11+
:link-type: ref
12+
13+
How to annotate images and videos using the napari points, labels, or shapes layers
14+
:::
15+
16+
:::{grid-item-card} Processing
17+
:link: processing
18+
:link-type: ref
19+
20+
Data processing with napari
21+
:::
22+
::::
23+
24+
::::{grid}
25+
:::{grid-item-card} Segmentation
26+
:link: segmentation
27+
:link-type: ref
28+
29+
Segmentation labeling with napari
30+
:::
31+
32+
:::{grid-item-card} Tracking
33+
:link: tracking
34+
:link-type: ref
35+
36+
How to work with object tracking data and how to format it for display as a napari tracks layer.
37+
:::
38+
::::
39+
840
## Improving the tutorials
941

1042
Our tutorials are hosted on [the napari Github repository](https://github.com/napari/napari).

docs/tutorials/processing/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(processing)=
12
# Processing
23

34
This section contains tutorials for data processing.

docs/tutorials/segmentation/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(segmentation)=
12
# Segmentation
23

34
This section contains tutorials for segmentation [labeling](../../howtos/layers/labels).

docs/tutorials/start_index.md

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,44 @@ The following documents will give you an overview of how to install and use
44
napari. For more detailed use-cases, check out the [napari tutorials](./index)
55
or [How-to guides](../howtos/index).
66

7-
- [napari quick start](./fundamentals/quick_start): This tutorial is for napari
8-
first-timers, to give them a quick glance of what napari does, and give it a try
9-
right away.
10-
- [How to install napari on your machine](./fundamentals/installation): This
11-
guide will teach you how to do a clean install of napari and launch the viewer.
12-
- [Getting started with napari](./fundamentals/getting_started): This tutorial
13-
will teach you all the different ways to launch napari.
14-
- [napari viewer tutorial](./fundamentals/viewer): This tutorial will teach you
15-
about the napari viewer, including how to use its graphical user interface (GUI)
7+
::::{grid}
8+
:::{grid-item-card} napari quick start
9+
:link: napari-quick-start
10+
:link-type: ref
11+
12+
A quick glance of what napari does aimed at first-timers.
13+
:::
14+
::::
15+
16+
::::{grid}
17+
:::{grid-item-card} How to install napari
18+
:link: installation
19+
:link-type: ref
20+
21+
How to do a clean install of napari and launch the viewer.
22+
:::
23+
24+
:::{grid-item-card} Getting started
25+
:link: getting-started
26+
:link-type: ref
27+
28+
This tutorial will teach you all the different ways to launch napari.
29+
:::
30+
::::
31+
32+
::::{grid}
33+
:::{grid-item-card} napari viewer tutorial
34+
:link: viewer-tutorial
35+
:link-type: ref
36+
37+
This tutorial will teach you about the napari viewer, including how to use its graphical user interface (GUI)
1638
and how the data within it is organized.
17-
- [Layers at a glance](../guides/layers): An overview of the napari *Layers*,
18-
the basic viewable objects that can be added to a viewer.
39+
:::
40+
41+
:::{grid-item-card} Layers at a glance
42+
:link: layers-glance
43+
:link-type: ref
44+
45+
An overview of the napari *Layers*, the basic viewable objects that can be displayed on the canvas.
46+
:::
47+
::::

0 commit comments

Comments
 (0)