Skip to content

Commit

Permalink
DOC #326 re-arrange
Browse files Browse the repository at this point in the history
  • Loading branch information
prjemian committed Apr 30, 2024
1 parent d8d2957 commit 82fdf31
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 19 deletions.
2 changes: 2 additions & 0 deletions docs/source/examples/notebooks/how_spec_commands.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. index:: SPEC; commands

.. _spec_commands_map:

========================
Expand Down
40 changes: 21 additions & 19 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,22 @@ Based on the *hkl* library (`documentation
Integrates with `ophyd <https://blueskyproject.io/ophyd>`_ pseudopositioners
for use with `bluesky <https://blueskyproject.io/bluesky>`_ plans.

.. toctree::
:glob:
:hidden:

overview
install
api
ready_to_use
examples/*
constraints
license
release_notes

.. icons: https://fonts.google.com/icons
.. grid:: 2
.. grid:: 3

.. grid-item-card:: :material-outlined:`summarize;3em` :ref:`overview`

Expand All @@ -41,24 +54,28 @@ for use with `bluesky <https://blueskyproject.io/bluesky>`_ plans.

.. grid-item-card:: :material-regular:`precision_manufacturing;3em` :ref:`geometries`

Diffractometer geometries.
All the diffractometer geometries.

.. grid-item-card:: :material-regular:`precision_manufacturing;3em` :ref:`ready_to_use`

Simulated diffractometers, ready to use.

.. grid-item-card:: :material-regular:`alt_route;3em` :ref:`examples`

Examples using the *hklpy* package.
Example notebooks, how-to guides, ...

.. grid-item-card:: :material-regular:`settings;3em` :ref:`configuration`

Record the diffractometer configuration.

.. grid-item-card:: :material-regular:`alt_route;3em` :ref:`constraints`
.. grid-item-card:: :material-regular:`filter_list;3em` :ref:`constraints`

Limit the number of reflections found.

.. grid-item-card:: :material-regular:`toc;3em` :ref:`spec_commands_map`

Bluesky for SPEC users.

.. grid-item-card:: :material-regular:`history;3em` :ref:`release_notes`

History of changes.
Expand All @@ -67,21 +84,6 @@ for use with `bluesky <https://blueskyproject.io/bluesky>`_ plans.

See below.

-----------------

.. toctree::
:glob:
:hidden:

overview
constraints
install
ready_to_use
examples/*
api
license
release_notes

.. _about:

About
Expand Down

0 comments on commit 82fdf31

Please sign in to comment.