Skip to content

Commit

Permalink
DOC anchors and indices
Browse files Browse the repository at this point in the history
  • Loading branch information
prjemian committed Apr 4, 2024
1 parent cda867f commit c698287
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
6 changes: 5 additions & 1 deletion docs/source/instrument/_configure_databroker.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
6 changes: 5 additions & 1 deletion docs/source/instrument/install_new_instrument.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. index:: install; new instrument

Install New Instrument
======================

Expand All @@ -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? <https://bcda-aps.github.io/bluesky_training/reference/_FAQ.html#faq-bash>`__

.. _checklist:

Installation checklist
--------------------------

Expand All @@ -31,7 +35,7 @@ Use the ``new_bluesky_instrument.py``
`program <https://github.com/BCDA-APS/bluesky_training/blob/main/new_bluesky_instrument.py>`__
to install a new bluesky instrument configuration from the online `APS
Bluesky Training <https://github.com/BCDA-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.

Expand Down

0 comments on commit c698287

Please sign in to comment.