Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 .github/workflows/publish-sphinx.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,17 @@ jobs:
with:
fetch-depth: 0 # otherwise, you will fail to push refs to dest repo

- name: Install sphinx-rtd-theme
- name: Install pandoc
run: |
pip install sphinx-rtd-theme
sudo apt-get update && sudo apt-get install pandoc

- name: Install Sphinx build requirements
run: |
pip install -r requirements-sphinx.txt

- name: Diagnostics
run: |
pip list

- name: Build and Commit
uses: sphinx-notes/pages@master
Expand Down
6 changes: 2 additions & 4 deletions apstools/devices/area_detector_support.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@
~AD_setup_FrameType
"""

# TODO: JPEG & TIFF similar to AD_EpicsFileNameHDF5Plugin

from collections import OrderedDict
from ophyd.areadetector.filestore_mixins import FileStoreBase
from ophyd.areadetector.filestore_mixins import FileStoreIterativeWrite
Expand Down Expand Up @@ -300,9 +298,9 @@ class AD_EpicsFileNameMixin(FileStorePluginBase):

.. caution:: *Caveat emptor* applies here. You assume expertise!

Replace standard Bluesky algorithm where file names
Replace standard ophyd file naming algorithm (where file names
are defined as UUID strings, virtually guaranteeing that
no existing images files will ever be overwritten.
no existing images files will ever be overwritten).

Caller is responsible for setting values of these Components:

Expand Down
4 changes: 2 additions & 2 deletions apstools/plans/alignment.py
Original file line number Diff line number Diff line change
Expand Up @@ -210,8 +210,8 @@ class TuneAxis(object):
RE(tuner.multi_pass_tune(width=2, num=9), live_table)
RE(tuner.tune(width=0.05, num=9), live_table)

Also see the jupyter notebook referenced here:
:ref:`example_tuneaxis`.
Also see the jupyter notebook tited **Demonstrate TuneAxis()**
in the :ref:`examples` section.

.. autosummary::

Expand Down
15 changes: 13 additions & 2 deletions docs/source/api/_devices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
Devices
=======

(ophyd) Devices that might be useful at the APS using Bluesky
Devices (subclasses of ophyd's `Device`) that might be useful at the APS using
Bluesky.

Also consult the :ref:`Index <genindex>` under the *Ophyd* heading for
links to the Devices, Exceptions, Mixins, Signals, and other support
Expand All @@ -13,6 +14,16 @@ items described here.
Categories
----------

See these categories:

* :ref:`devices.aps_support`
* :ref:`devices.area_detector`
* :ref:`devices.motors`
* :ref:`devices.scalers`
* :ref:`devices.shutters`
* :ref:`devices.slits`
* :ref:`devices.temperature_controllers`

.. _devices.aps_support:

APS General Support
Expand Down Expand Up @@ -44,7 +55,7 @@ Area Detector Support
~apstools.devices.area_detector_support.AD_EpicsTIFFIterativeWriter
~apstools.devices.area_detector_support.AD_full_file_name_local
~apstools.devices.area_detector_support.AD_plugin_primed
~apstools.devices.area_detector_support.AD_prime_plugin
~apstools.devices.area_detector_support.AD_prime_plugin2
~apstools.devices.area_detector_support.AD_setup_FrameType

.. _devices.scalers:
Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
sphinx.ext.mathjax
sphinx.ext.todo
sphinx.ext.viewcode
nbsphinx
""".split()

# Add any paths that contain templates here, relative to this directory.
Expand Down
Loading