mirror of
https://github.com/appium/appium.git
synced 2026-10-22 16:54:52 +08:00
Christopher Hiller
4955948651
This provides some tools for extension authors to easily setup and configure their packages to build docs and create documentation via TypeDoc & mkdocs.
774 B
774 B
@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.