Skip to content

Commit 180c20f

Browse files
authored
Merge pull request #163 from scipp/docs-tiles
Split user guide and cards on index pages
2 parents 666b507 + 8c76c65 commit 180c20f

12 files changed

+5500
-163
lines changed

docs/_static/thumbnails/estia_advanced_mcstas_reduction_dark.svg

Lines changed: 775 additions & 0 deletions
Loading

docs/_static/thumbnails/estia_advanced_mcstas_reduction_light.svg

Lines changed: 775 additions & 0 deletions
Loading

docs/_static/thumbnails/estia_mcstas_reduction_dark.svg

Lines changed: 1482 additions & 0 deletions
Loading

docs/_static/thumbnails/estia_mcstas_reduction_light.svg

Lines changed: 1482 additions & 0 deletions
Loading

docs/index.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,23 +28,26 @@
2828
</br></br>
2929
</div>
3030

31-
## Overview
31+
## Quick links
3232

33-
This documentation is under construction.
34-
See the [Amor data reduction](examples/amor) example for a quick start.
33+
::::{grid} 3
3534

36-
## Table of contents
35+
:::{grid-item-card} ESTIA
36+
:link: user-guide/estia/index.md
3737

38-
```{toctree}
39-
---
40-
maxdepth: 2
41-
---
38+
:::
4239

43-
user-guide/index
44-
api-reference/index
45-
developer/index
46-
about/index
47-
```
40+
:::{grid-item-card} Amor
41+
:link: user-guide/amor/index.md
42+
43+
:::
44+
45+
::::{grid-item-card} Offspec
46+
:link: user-guide/offspec/index.md
47+
48+
:::
49+
50+
::::
4851

4952
:::{include} user-guide/installation.md
5053
:heading-offset: 1
@@ -54,3 +57,14 @@ about/index
5457

5558
- If you have questions that are not answered by these documentation pages, ask on [discussions](https://github.com/scipp/essreflectometry/discussions). Please include a self-contained reproducible example if possible.
5659
- Report bugs (including unclear, missing, or wrong documentation!), suggest features or view the source code [on GitHub](https://github.com/scipp/essreflectometry).
60+
61+
```{toctree}
62+
---
63+
hidden:
64+
---
65+
66+
user-guide/index
67+
api-reference/index
68+
developer/index
69+
about/index
70+
```

docs/user-guide/amor/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@ maxdepth: 1
66
---
77
amor-reduction
88
compare-to-eos
9+
workflow-widget
910
```

docs/user-guide/amor/gui.ipynb renamed to docs/user-guide/amor/workflow-widget.ipynb

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
11
{
22
"cells": [
3+
{
4+
"cell_type": "markdown",
5+
"id": "0",
6+
"metadata": {},
7+
"source": [
8+
"# Workflow widget"
9+
]
10+
},
311
{
412
"cell_type": "code",
513
"execution_count": null,
6-
"id": "0",
14+
"id": "1",
715
"metadata": {},
816
"outputs": [],
917
"source": [
@@ -14,7 +22,7 @@
1422
{
1523
"cell_type": "code",
1624
"execution_count": null,
17-
"id": "1",
25+
"id": "2",
1826
"metadata": {},
1927
"outputs": [],
2028
"source": [
@@ -24,7 +32,7 @@
2432
{
2533
"cell_type": "code",
2634
"execution_count": null,
27-
"id": "2",
35+
"id": "3",
2836
"metadata": {},
2937
"outputs": [],
3038
"source": [
@@ -34,12 +42,12 @@
3442
{
3543
"cell_type": "code",
3644
"execution_count": null,
37-
"id": "3",
45+
"id": "4",
3846
"metadata": {},
3947
"outputs": [],
4048
"source": [
4149
"gui = AmorBatchReductionGUI()\n",
42-
"gui.widget\n"
50+
"gui.widget"
4351
]
4452
}
4553
],

0 commit comments

Comments
 (0)