Skip to content

docs: clean up Sphinx API doc generation and ExecuteDriver.Result typing - #1334

Open
hoanle0126 wants to merge 1 commit into
appium:masterfrom
hoanle0126:docs/improve-sphinx-api-docs-529
Open

hoanle0126 wants to merge 1 commit into
appium:masterfrom
hoanle0126:docs/improve-sphinx-api-docs-529

Conversation

@hoanle0126

Copy link
Copy Markdown
  • Promote ExecuteDriver.Result to a class-level inner class on ExecuteDriver and annotate execute_driver with -> 'ExecuteDriver.Result' (resolving # TODO Inner class case).
  • Fix the Usage code block indentation in ScreenRecord.stop_recording_screen so Sphinx builds without docutils errors.
  • Exclude TypeVar T and the internal webdriver.mobilecommand module from generated Sphinx API docs, add :no-index: on the package-level webdriver re-export section to avoid duplicate cross-reference warnings, and replace the sphinx-quickstart placeholder in docs/index.rst.

Refs #529

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant