diff --git a/.gitignore b/.gitignore index a45a710..0a24e33 100644 --- a/.gitignore +++ b/.gitignore @@ -68,6 +68,8 @@ instance/ # Sphinx documentation docs/_build/ +docs/build/ +docs/source/Eng/doc/api_reference/generated/ # PyBuilder target/ diff --git a/docs/source/Eng/doc/extended_features/extended_features_doc.rst b/docs/source/Eng/doc/extended_features/extended_features_doc.rst index 370331b..7898039 100644 --- a/docs/source/Eng/doc/extended_features/extended_features_doc.rst +++ b/docs/source/Eng/doc/extended_features/extended_features_doc.rst @@ -280,8 +280,8 @@ Reliability helpers * ``throttler.throttle("payments-api")`` — file-semaphore for cross-shard concurrency limits. -Observability -============= +Observability tooling +===================== * ``observability.timeline.build(spans=, console=, responses=)`` — merges three event sources into a chronological list. diff --git a/docs/source/Zh/doc/extended_features/extended_features_doc.rst b/docs/source/Zh/doc/extended_features/extended_features_doc.rst index a2781b7..5a39cc3 100644 --- a/docs/source/Zh/doc/extended_features/extended_features_doc.rst +++ b/docs/source/Zh/doc/extended_features/extended_features_doc.rst @@ -94,7 +94,7 @@ Appium(行動) * HTML — 單一 ``.html`` * JSON — 拆分 ``_success.json`` + ``_failure.json`` * XML — 拆分 ``_success.xml`` + ``_failure.xml`` -* JUnit XML — 單一 ``_junit.xml``(CI 原生) +* JUnit XML — 單一 ``_junit.xml``\ (CI 原生) * Allure — 目錄含多個 ``-result.json`` ``generate_all_reports(base, allure_dir=None)`` 一次跑完所有 generator 並 diff --git a/docs/source/conf.py b/docs/source/conf.py index c2931cb..f43da4f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -28,6 +28,10 @@ # Autosummary writes per-module reference pages on every build. autosummary_generate = True +# autosectionlabel collides on common section titles (Overview, Methods, +# Parameters, plus repeated CJK headings). Prefix every label with the +# document path so duplicates become unique. +autosectionlabel_prefix_document = True autodoc_default_options = { "members": True, "undoc-members": False, diff --git a/je_web_runner/element/web_element_wrapper.py b/je_web_runner/element/web_element_wrapper.py index 5fefd93..83958a0 100644 --- a/je_web_runner/element/web_element_wrapper.py +++ b/je_web_runner/element/web_element_wrapper.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from typing import List, Union from selenium.webdriver.remote.webelement import WebElement diff --git a/je_web_runner/utils/smart_wait/smart_wait.py b/je_web_runner/utils/smart_wait/smart_wait.py index 11e3f87..21c4730 100644 --- a/je_web_runner/utils/smart_wait/smart_wait.py +++ b/je_web_runner/utils/smart_wait/smart_wait.py @@ -128,7 +128,7 @@ def wait_for_spa_route_stable( ) -> None: """ 等到 ``history.pushState`` / ``replaceState`` / ``popstate`` - Wait until no history mutation has fired for at least ``quiet_for``s. + Wait until no history mutation has fired for at least ``quiet_for``\\ s. """ install_hooks(driver) deadline = time.monotonic() + timeout diff --git a/je_web_runner/webdriver/webdriver_with_options.py b/je_web_runner/webdriver/webdriver_with_options.py index dad62f9..e445683 100644 --- a/je_web_runner/webdriver/webdriver_with_options.py +++ b/je_web_runner/webdriver/webdriver_with_options.py @@ -1,3 +1,5 @@ +from __future__ import annotations + from typing import Union, List, Set from selenium import webdriver diff --git a/je_web_runner/webdriver/webdriver_wrapper.py b/je_web_runner/webdriver/webdriver_wrapper.py index 32d2db8..e562f88 100644 --- a/je_web_runner/webdriver/webdriver_wrapper.py +++ b/je_web_runner/webdriver/webdriver_wrapper.py @@ -1,3 +1,5 @@ +from __future__ import annotations + import typing from pathlib import Path from typing import List, Union