From 8fc716f04a8c176c0e93639f7a74c1afd572fd15 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=BC=A0=E7=90=A6?= Date: Fri, 23 Sep 2022 17:46:19 +0800 Subject: [PATCH] update docs (cherry picked from commit ad064b80014e87784aa8e6e7ae2b86d0d8e7549d) --- docs/README_MORE.rst | 5 ++++- docs/all_module/airtest.core.api.rst | 5 +++++ docs/all_module/airtest.core.assertions.rst | 7 +++++++ docs/all_module/airtest.core.ios.mjpeg_cap.rst | 7 +++++++ docs/all_module/airtest.core.rst | 1 + 5 files changed, 24 insertions(+), 1 deletion(-) create mode 100644 docs/all_module/airtest.core.assertions.rst create mode 100644 docs/all_module/airtest.core.ios.mjpeg_cap.rst diff --git a/docs/README_MORE.rst b/docs/README_MORE.rst index efbf7f1f..f9eb7149 100644 --- a/docs/README_MORE.rst +++ b/docs/README_MORE.rst @@ -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 ----------------------------------- @@ -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 \ No newline at end of file +.. _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 \ No newline at end of file diff --git a/docs/all_module/airtest.core.api.rst b/docs/all_module/airtest.core.api.rst index 1ab837d2..69cdcf8a 100644 --- a/docs/all_module/airtest.core.api.rst +++ b/docs/all_module/airtest.core.api.rst @@ -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 `_ \ No newline at end of file diff --git a/docs/all_module/airtest.core.assertions.rst b/docs/all_module/airtest.core.assertions.rst new file mode 100644 index 00000000..5604b672 --- /dev/null +++ b/docs/all_module/airtest.core.assertions.rst @@ -0,0 +1,7 @@ +airtest.core.assertions module +============================== + +.. automodule:: airtest.core.assertions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/all_module/airtest.core.ios.mjpeg_cap.rst b/docs/all_module/airtest.core.ios.mjpeg_cap.rst new file mode 100644 index 00000000..27e4b037 --- /dev/null +++ b/docs/all_module/airtest.core.ios.mjpeg_cap.rst @@ -0,0 +1,7 @@ +airtest.core.ios.mjpeg\_cap module +================================== + +.. automodule:: airtest.core.ios.mjpeg_cap + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/all_module/airtest.core.rst b/docs/all_module/airtest.core.rst index 1ef9eba0..ab7c1d2c 100644 --- a/docs/all_module/airtest.core.rst +++ b/docs/all_module/airtest.core.rst @@ -22,6 +22,7 @@ Submodules .. toctree:: airtest.core.api + airtest.core.assertions airtest.core.cv airtest.core.device airtest.core.error