Skip to content

Commit

Permalink
Tweak logo positions
Browse files Browse the repository at this point in the history
  • Loading branch information
coretl committed Jan 2, 2024
1 parent 46d2965 commit 058b2d2
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@

# scanspec

[![CI](https://github.com/dls-controls/scanspec/actions/workflows/code.yml/badge.svg)](https://github.com/dls-controls/scanspec/actions/workflows/code.yml)
[![Coverage](https://codecov.io/gh/dls-controls/scanspec/branch/master/graph/badge.svg)](https://codecov.io/gh/dls-controls/scanspec)
[![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)

<img src="https://raw.githubusercontent.com/dls-controls/scanspec/master/docs/images/scanspec-logo.svg" style="margin-right: 40px; background: none" width="150px" height="150px" align="left">
<img src="https://raw.githubusercontent.com/dls-controls/scanspec/master/docs/images/scanspec-logo.svg" style="background: none; float: right" width="160px" height="160px">

Specify step and flyscan Paths using combinations of:
- Specs like Line or Spiral
Expand Down Expand Up @@ -67,11 +66,8 @@ chunk.midpoints # {'x': <ndarray len=10>, 'y': <ndarray len=10>, 'DURATION': <n
chunk.upper # bounds are same dimensionality as positions
```

<!--
Anything below this line is used when viewing README.md and will be replaced
when included in index.md
-->

[plot]: https://raw.githubusercontent.com/dls-controls/scanspec/master/docs/images/plot_spec.png
<!-- README only content. Anything below this line won't be included in index.md -->

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
16 changes: 9 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,43 @@
```{include} ../README.md
:end-before: when included in index.md
:end-before: <!-- README only content
```

[plot]: images/plot_spec.png
[logo]: images/scanspec-logo.svg


How the documentation is structured
-----------------------------------

Documentation is split into four categories, also accessible from links in the
side-bar.
top bar.

<!-- https://sphinx-design.readthedocs.io/en/latest/grids.html -->

::::{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

Expand Down

0 comments on commit 058b2d2

Please sign in to comment.