search

bluesky / ophyd-async

Hardware abstraction for bluesky written using asyncio
https://blueskyproject.io/ophyd-async
BSD 3-Clause "New" or "Revised" License
8 stars 23 forks source link

Fix docs build #459

Open coretl opened 1 month ago

coretl commented 1 month ago

It is currently reporting:

WARNING: Summarised items should not include the current module. Replace 'ophyd_async.epics.areadetector' with 'areadetector'.
WARNING: Summarised items should not include the current module. Replace 'ophyd_async.epics.demo' with 'demo'.
WARNING: Summarised items should not include the current module. Replace 'ophyd_async.epics.motion' with 'motion'.
WARNING: Summarised items should not include the current module. Replace 'ophyd_async.epics.pvi' with 'pvi'.
WARNING: Summarised items should not include the current module. Replace 'ophyd_async.epics.signal' with 'signal'.
WARNING: Summarised items should not include the current module. Replace 'ophyd_async.epics.demo.demo_ad_sim_detector' with 'demo_ad_sim_detector'.
coretl commented 1 month ago

@olliesilvester FYI

evalott100 commented 1 month ago

Seems that when the autodoc generates ophyd_async.epics.rst:

.. note::

    Ophyd async is included on a provisional basis until the v1.0 release and 
    may change API on minor release numbers before then

ophyd\_async.epics
==================

.. automodule:: ophyd_async.epics

.. autosummary::
   :toctree:
   :template: custom-module-template.rst
   :recursive:

   ophyd_async.epics.areadetector
   ophyd_async.epics.demo
   ophyd_async.epics.motion
   ophyd_async.epics.pvi
   ophyd_async.epics.signal

The warning is caused by the ophyd_async. at the bottom, which doesn't match the other modules - e.g panda


   .. autosummary::
      :toctree:
      :template: custom-class-template.rst
      :nosignatures:

      CommonPandaBlocks
      HDFPanda
      PcompBlock
      PcompDirectionOptions
      EnableDisableOptions
      PcapBlock
      PulseBlock
      SeqBlock
      SeqTable
      SeqTableRow
      SeqTrigger
      PandaPcapController
      TimeUnits
      DataBlock
      StaticSeqTableTriggerLogic
      StaticPcompTriggerLogic

which doesn't include the ophyd_async. No idea how to fix this so @abbiemery should probably do her refactoring stuff first.

abbiemery commented 1 month ago

I have included sphinx and pinned it to allow the docs to build for now. We use sphinx via sphinx-autobuild so once we have solved the problem this can be removed again.