From c6982874d5fd80a83cb82e99f252395f81af9f1a Mon Sep 17 00:00:00 2001 From: Pete R Jemian Date: Thu, 4 Apr 2024 17:03:15 -0500 Subject: [PATCH] DOC anchors and indices --- docs/source/instrument/_configure_databroker.md | 6 +++++- docs/source/instrument/install_new_instrument.rst | 6 +++++- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/source/instrument/_configure_databroker.md b/docs/source/instrument/_configure_databroker.md index bbba35e9..49d2840d 100644 --- a/docs/source/instrument/_configure_databroker.md +++ b/docs/source/instrument/_configure_databroker.md @@ -1,6 +1,10 @@ # Setup your databroker catalog configuration -The bluesky instrument uses a YAML file which describes the connection +```{index} catalog; databroker +``` + + +The bluesky *instrument* uses a YAML file which describes the connection with some location where data is stored, typically a MongoDB collection. This is called a catalog configuration file. diff --git a/docs/source/instrument/install_new_instrument.rst b/docs/source/instrument/install_new_instrument.rst index 0d1d44f5..a8c43ccb 100644 --- a/docs/source/instrument/install_new_instrument.rst +++ b/docs/source/instrument/install_new_instrument.rst @@ -1,3 +1,5 @@ +.. index:: install; new instrument + Install New Instrument ====================== @@ -7,6 +9,8 @@ Describes the steps to install a new bluesky instrument. .. warning:: In Linux, use the ``bash`` command shell. For more info see `what is bash? `__ +.. _checklist: + Installation checklist -------------------------- @@ -31,7 +35,7 @@ Use the ``new_bluesky_instrument.py`` `program `__ to install a new bluesky instrument configuration from the online `APS Bluesky Training `__ -repository template. The program creates a new ``bluesky`` directory in +repository :index:`template`. The program creates a new ``bluesky`` directory in the home directory. Use ``new_bluesky_instrument.py -h`` for usage information.