Update documentation

FXIhub · Jan 4, 2024 · db6831b · db6831b
1 parent ebc5641
commit db6831b
Show file tree

Hide file tree

Showing 8 changed files with 41 additions and 46 deletions.
diff --git a/docs/API/analysis.rst b/docs/API/analysis.rst
@@ -4,47 +4,47 @@ analysis
 analysis.beamline
 -----------------
 
-.. automodule:: analysis.beamline
+.. automodule:: hummingbird.analysis.beamline
     :members:
     :undoc-members:
     :show-inheritance:
 
 analysis.event
 --------------
 
-.. automodule:: analysis.event
+.. automodule:: hummingbird.analysis.event
     :members:
     :undoc-members:
     :show-inheritance:
 
 analysis.hitfinding
 -------------------
 
-.. automodule:: analysis.hitfinding
+.. automodule:: hummingbird.analysis.hitfinding
     :members:
     :undoc-members:
     :show-inheritance:
 
 analysis.sizing
 ---------------
 
-.. automodule:: analysis.sizing
+.. automodule:: hummingbird.analysis.sizing
     :members:
     :undoc-members:
     :show-inheritance:
 
 analysis.pixel_detector
 -----------------------
 
-.. automodule:: analysis.pixel_detector
+.. automodule:: hummingbird.analysis.pixel_detector
     :members:
     :undoc-members:
     :show-inheritance:
 
 analysis.template
 -----------------
 
-.. automodule:: analysis.template
+.. automodule:: hummingbird.analysis.template
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/API/backend.rst b/docs/API/backend.rst
@@ -1,32 +1,32 @@
 backend
 =======
 
-.. automodule:: backend
+.. automodule:: hummingbird.backend
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: backend.Worker
+.. autoclass:: hummingbird.backend.Worker
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: backend.EventTranslator
+.. autoclass:: hummingbird.backend.EventTranslator
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: backend.Record
+.. autoclass:: hummingbird.backend.Record
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autofunction:: backend.add_record
+.. autofunction:: hummingbird.backend.add_record
 
-backend.lcls
-------------
+hummingbird.backend.lcls
+------------------------
 
-.. automodule:: backend.lcls
+.. automodule:: hummingbird.backend.lcls
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/API/interface.rst b/docs/API/interface.rst
@@ -1,44 +1,44 @@
 interface
 =========
 
-.. automodule:: interface
+.. automodule:: hummingbird.interface
 
-.. autoclass:: interface.GUI
+.. autoclass:: hummingbird.interface.GUI
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: interface.DataSource
+.. autoclass:: hummingbird.interface.DataSource
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: interface.PlotData
+.. autoclass:: hummingbird.interface.PlotData
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: interface.H5Recorder
+.. autoclass:: hummingbird.interface.H5Recorder
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: interface.RingBuffer
+.. autoclass:: hummingbird.interface.RingBuffer
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: interface.ZmqContext
+.. autoclass:: hummingbird.interface.ZmqContext
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autoclass:: interface.ZmqSocket
+.. autoclass:: hummingbird.interface.ZmqSocket
     :members:
     :undoc-members:
     :show-inheritance:
 
-.. autofunction:: interface.start_interface
+.. autofunction:: hummingbird.interface.start_interface
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/API/ipc.rst b/docs/API/ipc.rst
@@ -1,27 +1,27 @@
 ipc
 ===
 
-.. automodule:: ipc
+.. automodule:: hummingbird.ipc
     :members:
     :undoc-members:
 
 broadcast
 ---------
 
-.. automodule:: ipc.broadcast
+.. automodule:: hummingbird.ipc.broadcast
     :members:
     :undoc-members:
 
 mpi
 ---
 
-.. automodule:: ipc.mpi
+.. automodule:: hummingbird.ipc.mpi
     :members:
     :undoc-members:
 
 zmqserver
 ---------
-.. automodule:: ipc.zmqserver
+.. automodule:: hummingbird.ipc.zmqserver
     :members:
     :undoc-members:
 

diff --git a/docs/API/plotting.rst b/docs/API/plotting.rst
@@ -4,23 +4,23 @@ plotting
 plotting.line
 -------------
 
-.. automodule:: plotting.line
+.. automodule:: hummingbird.plotting.line
     :members:
     :undoc-members:
     :show-inheritance:
 
 plotting.image
 --------------
 
-.. automodule:: plotting.image
+.. automodule:: hummingbird.plotting.image
     :members:
     :undoc-members:
     :show-inheritance:
 
 plotting.correlation
 --------------------
 
-.. automodule:: plotting.correlation
+.. automodule:: hummingbird.plotting.correlation
     :members:
     :undoc-members:
     :show-inheritance:
diff --git a/docs/API/ui.rst b/docs/API/ui.rst
@@ -3,17 +3,17 @@ ui
 
 .. automodule:: interface.ui
 
-.. autoclass:: interface.ui.DataWindow
+.. autoclass:: hummingbird.interface.ui.DataWindow
      :members:
      :undoc-members:
      :show-inheritance:
 
-.. autoclass:: interface.ui.PlotWindow
+.. autoclass:: hummingbird.interface.ui.PlotWindow
      :members:
      :undoc-members:
      :show-inheritance:
 
-.. autoclass:: interface.ui.ImageWindow
+.. autoclass:: hummingbird.interface.ui.ImageWindow
      :members:
      :undoc-members:
      :show-inheritance:

diff --git a/docs/API/utils.rst b/docs/API/utils.rst
@@ -1,28 +1,28 @@
 utils
 =====
 
-.. automodule:: utils
+.. automodule:: hummingbird.utils
     :members:
     :undoc-members:
 
 reader
 ------
 
-.. automodule:: utils.reader
+.. automodule:: hummingbird.utils.reader
     :members:
     :undoc-members:
 
 array
 -----
 
-.. automodule:: utils.array
+.. automodule:: hummingbird.utils.array
     :members:
     :undoc-members:
 
 io
 --
 
-.. automodule:: utils.io
+.. automodule:: hummingbird.utils.io
     :members:
     :undoc-members:
 
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -13,10 +13,8 @@ Here is an example of a configuration file used to gather some basic statistics
 about a run stored in an XTC file:
 
 ::
-
-   import analysis.event
-   import analysis.beamline
-   import analysis.pixel_detector
+   
+   from hummingbird import analysis
    
    state = {
        'Facility': 'LCLS',
@@ -37,12 +35,9 @@ modules are imported:
 
 ::
 
-   import analysis.event
-   import analysis.beamline
-   import analysis.pixel_detector
+   from hummingbird import analysis
 
-In this case three modules are imported. You can find what modules are available
-by peeking into the ``src/analysis`` and ``src/plotting`` directory or by browsing the 
+You can find what modules are available by peeking into the ``hummingbird/analysis`` and ``hummingbird/plotting`` directory or by browsing the 
 :doc:`API documentation <API/modules>`.