Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
(cherry picked from commit ad064b8)
  • Loading branch information
yimelia committed Sep 23, 2022
1 parent d3dccb7 commit 8fc716f
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/README_MORE.rst
Original file line number Diff line number Diff line change
Expand Up @@ -262,9 +262,11 @@ Airtest provide some assert functions, including:
- assert_not_exists
- assert_equal
- assert_not_equal
- ...

When assertion fails, it will raise ``AssertsionError``. And you will see all assertions in the html report.

All assert statements can be found here: `airtest.core.assertions`_

Running ``.air`` from CLI
-----------------------------------
Expand Down Expand Up @@ -373,4 +375,5 @@ You can write some common used function in one ``.air`` script and import it fro
.. _AirLab: https://airlab.163.com
.. _airtest.core.android.Android class: ./all_module/airtest.core.android.android.html
.. _airtest.core.win.Windows class: ./all_module/airtest.core.win.win.html#airtest.core.win.win.Windows
.. _airtest.core.ios.IOS class: ./all_module/airtest.core.ios.ios.html#airtest.core.ios.ios.IOS
.. _airtest.core.ios.IOS class: ./all_module/airtest.core.ios.ios.html#airtest.core.ios.ios.IOS
.. _airtest.core.assertions: ./all_module/airtest.core.assertions.html
5 changes: 5 additions & 0 deletions docs/all_module/airtest.core.api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,8 @@ airtest.core.api module
:members:
:undoc-members:
:show-inheritance:

Assertions in airtest
======================

All assert statements can be found here: `airtest.core.assertions <airtest.core.assertions.html>`_
7 changes: 7 additions & 0 deletions docs/all_module/airtest.core.assertions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
airtest.core.assertions module
==============================

.. automodule:: airtest.core.assertions
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions docs/all_module/airtest.core.ios.mjpeg_cap.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
airtest.core.ios.mjpeg\_cap module
==================================

.. automodule:: airtest.core.ios.mjpeg_cap
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/all_module/airtest.core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Submodules
.. toctree::

airtest.core.api
airtest.core.assertions
airtest.core.cv
airtest.core.device
airtest.core.error
Expand Down

0 comments on commit 8fc716f

Please sign in to comment.