Skip to content

Commit

Permalink
docs(api): better H2 structure for API Reference page (#14016)
Browse files Browse the repository at this point in the history
  • Loading branch information
ecormany authored Nov 20, 2023
1 parent e348535 commit 7239a53
Showing 1 changed file with 18 additions and 13 deletions.
31 changes: 18 additions & 13 deletions api/docs/v2/new_protocol_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,41 +2,46 @@

.. _protocol-api-reference:

***********************
API Version 2 Reference
=======================
***********************

.. _protocol_api-protocols-and-instruments:

Protocols and Instruments
-------------------------
Protocols
=========
.. module:: opentrons.protocol_api

.. autoclass:: opentrons.protocol_api.ProtocolContext
:members:
:exclude-members: location_cache, cleanup, clear_commands, load_waste_chute
:exclude-members: location_cache, cleanup, clear_commands

Instruments
===========
.. autoclass:: opentrons.protocol_api.InstrumentContext
:members:
:exclude-members: delay, configure_nozzle_layout, prepare_to_aspirate

.. autoclass:: opentrons.protocol_api.Liquid
:exclude-members: delay

.. _protocol-api-labware:

Labware and Wells
-----------------
Labware
=======
.. autoclass:: opentrons.protocol_api.Labware
:members:
:exclude-members: next_tip, use_tips, previous_tip, return_tips

Wells and Liquids
=================
.. autoclass:: opentrons.protocol_api.Well
:members:
:exclude-members: geometry

.. autoclass:: opentrons.protocol_api.Liquid

.. _protocol-api-modules:

Modules
-------
=======

.. autoclass:: opentrons.protocol_api.HeaterShakerContext
:members:
Expand Down Expand Up @@ -66,8 +71,8 @@ Modules

.. _protocol-api-types:

Useful Types and Definitions
----------------------------
Useful Types
============

..
The opentrons.types module contains a mixture of public Protocol API things and private internal things.
Expand All @@ -80,7 +85,7 @@ Useful Types and Definitions
:no-value:

Executing and Simulating Protocols
----------------------------------
==================================

.. automodule:: opentrons.execute
:members:
Expand Down

0 comments on commit 7239a53

Please sign in to comment.