@appium/docutils 1.0.1 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +14 -10
  2. package/package.json +5 -5
  3. package/requirements.txt +2 -2
package/README.md CHANGED
@@ -2,21 +2,25 @@
2
2
 
3
3
  > Documentation-building utilities for Appium
4
4
 
5
- ## Prerequisites
5
+ [![NPM version](http://img.shields.io/npm/v/@appium/docutils.svg)](https://npmjs.org/package/@appium/docutils)
6
+ [![Downloads](http://img.shields.io/npm/dm/@appium/docutils.svg)](https://npmjs.org/package/@appium/docutils)
6
7
 
7
- - Node.js in the [semantic version range](https://semver.org) `^14.17.0 || ^16.13.0 || >=18.0.0`
8
- - Python v3+ if building HTML documentation
8
+ ## Setup for Main Appium Docs
9
9
 
10
- ## Running for Main Appium Docs
11
-
12
- This package does not need to be run directly. Instead, execute this command in the `packages/appium` folder of [this monorepo](https://github.com/appium/appium):
10
+ This package does not need to be run directly. Instead, execute this command in the
11
+ `packages/appium` directory:
13
12
 
14
13
  ```bash
15
14
  npm run dev:docs:en
16
- ````
15
+ ```
16
+
17
+ Note that this will only build the English docs. See the `scripts` field of the `package.json` for
18
+ other languages.
19
+
20
+ ## Setup for Appium Drivers and Plugins
17
21
 
18
- See the `scripts` field of the `package.json` for other languages.
22
+ See the Appium docs on [Building Documentation](http://appium.io/docs/en/latest/developing/build-docs/).
19
23
 
20
- ## Using in Appium Extensions
24
+ ## License
21
25
 
22
- 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.
26
+ Apache-2.0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appium/docutils",
3
- "version": "1.0.1",
3
+ "version": "1.0.2",
4
4
  "description": "Documentation generation utilities for Appium and related projects",
5
5
  "keywords": [
6
6
  "automation",
@@ -48,7 +48,7 @@
48
48
  "start": "node ./build/lib/cli/index.js"
49
49
  },
50
50
  "dependencies": {
51
- "@appium/support": "^4.1.11",
51
+ "@appium/support": "^4.2.0",
52
52
  "@appium/tsconfig": "^0.x",
53
53
  "@sliphua/lilconfig-ts-loader": "3.2.2",
54
54
  "@types/which": "3.0.3",
@@ -57,7 +57,7 @@
57
57
  "diff": "5.1.0",
58
58
  "figures": "3.2.0",
59
59
  "json5": "2.2.3",
60
- "lilconfig": "2.1.0",
60
+ "lilconfig": "3.0.0",
61
61
  "lodash": "4.17.21",
62
62
  "log-symbols": "4.1.0",
63
63
  "pkg-dir": "5.0.0",
@@ -65,7 +65,7 @@
65
65
  "semver": "7.5.4",
66
66
  "source-map-support": "0.5.21",
67
67
  "teen_process": "2.1.1",
68
- "type-fest": "4.8.3",
68
+ "type-fest": "4.9.0",
69
69
  "typescript": "5.2.2",
70
70
  "yaml": "2.3.4",
71
71
  "yargs": "17.7.2",
@@ -78,5 +78,5 @@
78
78
  "publishConfig": {
79
79
  "access": "public"
80
80
  },
81
- "gitHead": "5c1d20517cfc8773cd5ffb0f8bb996668d71116b"
81
+ "gitHead": "76df4d600dcb7c867c37c3d7d302dc7fcc95ae09"
82
82
  }
package/requirements.txt CHANGED
@@ -1,5 +1,5 @@
1
1
  mkdocs==1.5.3
2
- mkdocs-git-revision-date-localized-plugin==1.2.1
3
- mkdocs-material==9.5.2
2
+ mkdocs-git-revision-date-localized-plugin==1.2.2
3
+ mkdocs-material==9.5.3
4
4
  mkdocs-redirects==1.2.1
5
5
  mike==2.0.0