From 102e3983b5cd34147552f03c693ee12b1bee485b Mon Sep 17 00:00:00 2001 From: Sebastien Bourdeauducq Date: Thu, 22 Mar 2018 12:06:01 +0800 Subject: [PATCH] manual: reorganize core drivers --- doc/manual/core_drivers_reference.rst | 136 +++++++++++++++----------- 1 file changed, 79 insertions(+), 57 deletions(-) diff --git a/doc/manual/core_drivers_reference.rst b/doc/manual/core_drivers_reference.rst index 8655fbcea..66e3cfea6 100644 --- a/doc/manual/core_drivers_reference.rst +++ b/doc/manual/core_drivers_reference.rst @@ -3,104 +3,126 @@ Core drivers reference These drivers are for the core device and the peripherals closely integrated into it, which do not use the controller mechanism. + +System drivers +-------------- + :mod:`artiq.coredevice.core` module ------------------------------------ ++++++++++++++++++++++++++++++++++++ .. automodule:: artiq.coredevice.core :members: -:mod:`artiq.coredevice.ttl` module ----------------------------------- +:mod:`artiq.coredevice.exceptions` module ++++++++++++++++++++++++++++++++++++++++++ -.. automodule:: artiq.coredevice.ttl - :members: - -:mod:`artiq.coredevice.dds` module ----------------------------------- - -.. automodule:: artiq.coredevice.dds +.. automodule:: artiq.coredevice.exceptions :members: :mod:`artiq.coredevice.dma` module ----------------------------------- +++++++++++++++++++++++++++++++++++ .. automodule:: artiq.coredevice.dma :members: +:mod:`artiq.coredevice.cache` module +++++++++++++++++++++++++++++++++++++ + +.. automodule:: artiq.coredevice.cache + :members: + + +Digital I/O drivers ++++++++++++++++++++ + +:mod:`artiq.coredevice.ttl` module +++++++++++++++++++++++++++++++++++ + +.. automodule:: artiq.coredevice.ttl + :members: + +:mod:`artiq.coredevice.shiftreg` module +++++++++++++++++++++++++++++++++++ + +.. automodule:: artiq.coredevice.shiftreg + :members: + :mod:`artiq.coredevice.spi2` module ------------------------------------ ++++++++++++++++++++++++++++++++++++ .. automodule:: artiq.coredevice.spi2 :members: -:mod:`artiq.coredevice.ad5360` module -------------------------------------- - -.. automodule:: artiq.coredevice.ad5360 - :members: - :mod:`artiq.coredevice.i2c` module ----------------------------------- +++++++++++++++++++++++++++++++++++ .. automodule:: artiq.coredevice.i2c :members: :mod:`artiq.coredevice.pcf8574a` module ---------------------------------------- ++++++++++++++++++++++++++++++++++++++++ .. automodule:: artiq.coredevice.pcf8574a :members: -:mod:`artiq.coredevice.cache` module ------------------------------------- -.. automodule:: artiq.coredevice.cache - :members: - -:mod:`artiq.coredevice.exceptions` module ------------------------------------------ - -.. automodule:: artiq.coredevice.exceptions - :members: - -:mod:`artiq.coredevice.spline` module -------------------------------------- - -.. automodule:: artiq.coredevice.spline - :members: - -:mod:`artiq.coredevice.sawg` module ------------------------------------ - -.. automodule:: artiq.coredevice.sawg - :members: - -:mod:`artiq.coredevice.novogorny` module ----------------------------------------- - -.. automodule:: artiq.coredevice.novogorny - :members: - -:mod:`artiq.coredevice.sampler` module --------------------------------------- - -.. automodule:: artiq.coredevice.sampler - :members: +RF generation drivers +--------------------- :mod:`artiq.coredevice.urukul` module -------------------------------------- ++++++++++++++++++++++++++++++++++++++ .. automodule:: artiq.coredevice.urukul :members: :mod:`artiq.coredevice.ad9912` module -------------------------------------- ++++++++++++++++++++++++++++++++++++++ .. automodule:: artiq.coredevice.ad9912 :members: :mod:`artiq.coredevice.ad9910` module -------------------------------------- ++++++++++++++++++++++++++++++++++++++ .. automodule:: artiq.coredevice.ad9910 :members: + +:mod:`artiq.coredevice.spline` module ++++++++++++++++++++++++++++++++++++++ + +.. automodule:: artiq.coredevice.spline + :members: + +:mod:`artiq.coredevice.sawg` module ++++++++++++++++++++++++++++++++++++ + +.. automodule:: artiq.coredevice.sawg + :members: + +:mod:`artiq.coredevice.dds` module +++++++++++++++++++++++++++++++++++ + +.. automodule:: artiq.coredevice.dds + :members: + + +DAC/ADC drivers +--------------- + +:mod:`artiq.coredevice.ad5360` module ++++++++++++++++++++++++++++++++++++++ + +.. automodule:: artiq.coredevice.ad5360 + :members: + +:mod:`artiq.coredevice.sampler` module +++++++++++++++++++++++++++++++++++++++ + +.. automodule:: artiq.coredevice.sampler + :members: + +:mod:`artiq.coredevice.novogorny` module +++++++++++++++++++++++++++++++++++++++++ + +.. automodule:: artiq.coredevice.novogorny + :members: