diff --git a/README.md b/README.md index fcc5fa0c..fa5288f5 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,3 @@ - # scanspec [![CI](https://github.com/dls-controls/scanspec/actions/workflows/code.yml/badge.svg)](https://github.com/dls-controls/scanspec/actions/workflows/code.yml) @@ -6,7 +5,7 @@ [![PyPI](https://img.shields.io/pypi/v/scanspec.svg)](https://pypi.org/project/scanspec) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) - + Specify step and flyscan Paths using combinations of: - Specs like Line or Spiral @@ -67,11 +66,8 @@ chunk.midpoints # {'x': , 'y': , 'DURATION': - -[plot]: https://raw.githubusercontent.com/dls-controls/scanspec/master/docs/images/plot_spec.png + See https://dls-controls.github.io/scanspec for more detailed documentation. + +[plot]: https://raw.githubusercontent.com/dls-controls/scanspec/master/docs/images/plot_spec.png diff --git a/docs/index.md b/docs/index.md index 6fc777b5..10955d0d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,41 +1,43 @@ ```{include} ../README.md -:end-before: when included in index.md +:end-before: ::::{grid} 2 :gutter: 4 -:::{grid-item-card} {material-regular}`directions_walk;3em` +:::{grid-item-card} {material-regular}`directions_walk;2em` Tutorials :link: tutorials :link-type: doc Tutorials for installation and typical usage. New users start here. ::: -:::{grid-item-card} {material-regular}`directions;3em` +:::{grid-item-card} {material-regular}`directions;2em` How-to Guides :link: how-to :link-type: doc Practical step-by-step guides for the more experienced user. ::: -:::{grid-item-card} {material-regular}`info;3em` +:::{grid-item-card} {material-regular}`info;2em` Explanations :link: explanations :link-type: doc Explanations of how it works and why it works that way. ::: -:::{grid-item-card} {material-regular}`menu_book;3em` +:::{grid-item-card} {material-regular}`menu_book;2em` Reference :link: reference :link-type: doc