mirror of
https://github.com/appium/appium.git
synced 2026-02-21 18:59:08 -06:00
2766dcca4c
This makes `appium-docs init` add a needed prop (`typedoc.entryPoint`) to `package.json` of an extension. It will write to `package.json` _by default_, even if it exists--which is different than the default behavior of other scaffolding tasks. Note that `appium-docs init` will now _fail_ if `--entry-point <some-file>` (or `-e`) is not provided; there's no way for us to guess what it is (this is the _source_ entry point; not necessarily the `main` file). I guess that's technically breaking, but `appium-docs init` should not be part of anyone's workflow.
@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.