JSPM

  • Created
  • Published
  • Downloads 339317
  • Score
    100M100P100Q187788F
  • License Apache-2.0

Documentation generation utilities for Appium and related projects

Package Exports

  • @appium/docutils
  • @appium/docutils/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@appium/docutils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@appium/docutils

Documentation-building utilities for Appium

Prerequisites

  • Node.js in the semantic version range ^14.17.0 || ^16.13.0 || >=18.0.0
  • Python v3+ if building HTML documentation

Running for Main Appium Docs

This package does not need to be run directly. Instead, execute this command in the packages/appium folder of this monorepo:

npm run dev:docs:en

See the scripts field of the package.json for other languages.

Using in Appium Extensions

TODO: give an example of how this package is used in an extension outside the appium monorepo, for example when it's made a part of the XCUITest repo. Or link to the part of the Appium docs where this info will live.