appium/packages/docutils/README.md

@appium/docutils

Documentation-building utilities for Appium

Prerequisites

• mkdocs v1.4.0
• mkdocs-material v8.2.8
• mkdocs-material-extensions v1.0.3

Run pip install -r requirements.txt to install MkDocs & its deps.

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.