TypeDoc plugin for Appium & its extensions
npm install @appium/typedoc-plugin-appium@appium/typedoc-plugin-appium> TypeDoc plugin for Appium & its extensions
This package leverages TypeDoc to generate command documentation (HTTP endpoints, payload information, etc.) for Appium v2+ drivers and plugins.
_If you are an Appium extension author and just want to build HTML docs_, don't install this directly--instead, install @appium/docutils, which is a higher-level package that configures everything for you.
If you _only_ want to build markdown docs for your extension, then you can use this package directly.
npm v8+ is required to install this package.
``bash`
npm install @appium/typedoc-plugin-appium --save-dev
The above command installs the plugin as well as all necessary peer dependencies. See package.json for the full list of dependencies.
TypeDoc is configured via a typedoc.json or typedoc.js file (read the docs for more information).
An Appium extension author wishing to generate markdown documentation for their extension will need to create a typedoc.json. At minimum, it should contain:
`json`
{
"entryPointStrategy": "packages",
"entryPoints": ["."],
"name": "
"theme": "appium",
"out": "
}
Once this file is created, you can run typedoc to generate the documentation, and it will be output into the out directory as configured above.
This plugin supports all of the options from typedoc-plugin-markdown, as well as the following:
boolean - Output module, class, interface, and other type information (the usual TypeDoc output) in addition to command documentation. This is needed for full documentation of types. _Default value: true_
boolean - Outputs _all_ commands and types from Appium builtins--not just your extension. This is intended to be used by Appium itself. _Default value: false_
Array<{name: string, title: string}>: An array of objects containing module name name and display name title. By default, the module name is used for the title; use this to override that behavior. _Default value: undefined_
string - The name of the "commands" directory relative to the TypeDoc output directory (out). _Default value: commands_
boolean - Forces breadcrumbs to be output; overrides hideBreadcrumbs from typedoc-plugin-markdown. _Default value: false_
This packages uses snapshot tests to assert the generated markdown is correct. If you have made changes which affect the plugin's output, you will need to update the snapshots.
To update the snapshots, execute:
`bash``
UPDATE_SNAPSHOT=1 npm run test:e2e
This will (likely) modify the snapshots in your working copy, so you will then need to commit them.
Copyright © 2022 OpenJS Foundation. Licensed Apache-2.0