guitastrolib / guitastro

Commit c1f67e41fd6ca7de6dc5234a33fb68f607be046f

Authored by Alain Klotz
1 parent 6e6c3916
Exists in master

documentation update

Showing 4 changed files with 13 additions and 6 deletions   Show diff stats
Inline Side-by-side
docs/make.bat renamed to docs/make_doc.bat
  Diff comments   View file @c1f67e4
docs/source/device_definition.rst
  Diff comments   View file @c1f67e4
... ... @@ -68,8 +68,9 @@ When the component/action/operation = MountPointing/DO/RADEC_GOTO, the operation
68 68  
69 69 A given category of component have a list of operations. For example for a MountPointing:
70 70  
71   - * **RADEC_COORD**: Returns the current coordinates in the RA,Dec system
72   - * **RADEC_GOTO**: Slew the mount until a target previously defined by a command
  71 + * **COORD RADEC**: Returns the current coordinates in the RA,Dec system
  72 + * **COORD HADEC**: Returns the current coordinates in the HA,Dec system
  73 + * **GOTO**: Slew the mount until a target previously defined by a command
73 74  
74 75 3. Integration of components into devices for Guitastro
75 76 *******************************************************
... ... @@ -97,9 +98,10 @@ can be used to give optional parameters.
97 98 To summarize:
98 99  
99 100 * The class **Component** provides basic methods: command, parameters, prop, init and attributes categories, channel, category, log, verbose, actions
100   - * The class **ComponentMountPointing** overload mainly the method prop to define the list of actions/operations and _do for a simulator.
101   - * The class **ComponentMountPointingMeadeMount** overload mainly the method _my_do for real driving of the mount. _my_do is called after _do.
102   - * The class **Device_MeadeMount** provides communication methods: open, close, commandstring, command and provides information method components.
  101 + * The class **ComponentMountPointing** override mainly the method prop to define the list of actions/operations and _do for a simulator.
  102 + * The class **ComponentMountPointingMeadeMount** override mainly the method _my_do for real driving of the mount. _my_do is called after _do.
  103 + * The class **Device** provides communication methods: open, close, commandstring, command and provides information method components.
  104 + * The class **Device_MeadeMount** override device class methods to adapt them to the specificities of the real device.
103 105  
104 106 The following example shows how to instanciate and send commands:
105 107  
... ...
docs/source/generate_documentation.rst
  Diff comments   View file @c1f67e4
... ... @@ -68,4 +68,4 @@ Procedure for Windows. Open a PowerShell as administrator:
68 68 .. code-block:: bash
69 69  
70 70 cd C:\Users\uuu\Documents\xxx\docs
71   - .\make
  71 + .\make_doc
... ...
src/guitastro/__init__.py
  Diff comments   View file @c1f67e4
... ... @@ -140,6 +140,11 @@ guitastro.component_mount_pointing
140 140 .. automodule:: guitastro.component_mount_pointing
141 141 :members:
142 142  
  143 +guitastro.device
  144 +-------------------
  145 +.. automodule:: guitastro.device
  146 + :members:
  147 +
143 148 """
144 149 from __future__ import (absolute_import, division, print_function,
145 150 unicode_literals)
... ...