Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(api): Fix docs build failure after move to legacy_api #2469

Merged
merged 1 commit into from
Oct 12, 2018
Merged

fix(api): Fix docs build failure after move to legacy_api #2469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions api/docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Robot

All protocols are set up, simulated and executed using a Robot class.

.. autoclass:: Robot
.. autoclass:: opentrons.legacy_api.robot.Robot
:members: connect, home, reset, run, simulate, commands, move_to, disconnect, head_speed, pause, resume, stop, get_warnings, add_instrument, get_motor

Pipette
-----------------

.. module:: opentrons.instruments
.. module:: opentrons.legacy_api.instruments

.. autoclass:: Pipette
:members: aspirate, dispense, mix, delay, drop_tip, blow_out, touch_tip, pick_up_tip, return_tip, move_to, home, set_flow_rate
.. autoclass:: opentrons.legacy_api.instruments.Pipette
:members: aspirate, dispense, mix, delay, drop_tip, blow_out, touch_tip, pick_up_tip, return_tip, move_to, home, set_flow_rate
2 changes: 1 addition & 1 deletion api/opentrons/legacy_api/instruments/pipette.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ class Pipette:
DIRECT USE OF THIS CLASS IS DEPRECATED -- this class should not be used
directly. Its parameters, defaults, methods, and behaviors are subject to
change without a major version release. Use the model-specific constructors
available through `from opentrons import instruments`.
available through ``from opentrons import instruments``.

All model-specific instrument constructors are inheritors of this class.
With any of those instances you can can:
Expand Down
3 changes: 3 additions & 0 deletions api/opentrons/legacy_api/robot/robot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ class Robot(object):
"""
This class is the main interface to the robot.

It should never be instantiated directly; instead, the global instance may
be accessed at :py:attr:``opentrons.robot``.

Through this class you can can:
* define your :class:`opentrons.Deck`
* :meth:`connect` to Opentrons physical robot
Expand Down