Skip to content

Fix warnings and errors found when generating docs #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwlodek merged 1 commit into from
Jul 2, 2026
Merged

Fix warnings and errors found when generating docs #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions docs/ADMythen/ADMythen.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,10 @@ Installation
------------

Prerequisites
~~~~~~~~~~~~
~~~~~~~~~~~~~

Required EPICS Modules
^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^

* **EPICS Base**: Version 3.14.12 or later (or EPICS 7.x)
* **areaDetector Modules**:
Expand Down Expand Up @@ -417,10 +417,12 @@ Detector Settings
**SD_SETTING** (mbbo/mbbi)
* **Description**: Detector setting for predefined X-ray source configurations
* **Values**:

* 0 = Cu (Copper)
* 1 = Mo (Molybdenum)
* 2 = Ag (Silver)
* 3 = Cr (Chromium)

* **Access**: Read/Write
* **EPICS Records**: ``$(P)$(R)Setting``, ``$(P)$(R)Setting_RBV``

Expand Down Expand Up @@ -451,18 +453,22 @@ Acquisition Parameters
**SD_TRIGGER** (mbbo/mbbi)
* **Description**: Trigger mode
* **Values**:

* 0 = None (software trigger only)
* 1 = Single (external trigger for single frame)
* 2 = Continuous (continuous acquisition on external triggers)

* **Default**: 0 (None)
* **Access**: Read/Write
* **EPICS Records**: ``$(P)$(R)TriggerMode``, ``$(P)$(R)TriggerMode_RBV``

**SD_READ_MODE** (mbbo/mbbi)
* **Description**: Data readout mode
* **Values**:

* 0 = Raw (uncorrected data from detector)
* 1 = Corrected (data with corrections applied)

* **Default**: 0 (Raw)
* **Access**: Read/Write
* **EPICS Records**: ``$(P)$(R)ReadMode``, ``$(P)$(R)ReadMode_RBV``
Expand Down Expand Up @@ -526,10 +532,12 @@ Data Format
**SD_BIT_DEPTH** (mbbo/longin)
* **Description**: Bit depth for data readout
* **Values**:

* 0 = 24 bits
* 1 = 16 bits
* 2 = 8 bits
* 3 = 4 bits

* **Default**: 0 (24 bits)
* **Access**: Read/Write
* **EPICS Records**: ``$(P)$(R)BitDepth``, ``$(P)$(R)BitDepth_RBV``
Expand Down