@appium/docutils 0.3.8 → 0.3.9

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.
@@ -1 +1 @@
1
- {"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAO,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAK1D,OAAO,EAAmC,0BAA0B,EAAY,MAAM,SAAS,CAAC;AAuChG;;;GAGG;AACH,wBAAsB,SAAS,CAAC,EAC9B,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAkB,EAClB,GAAmB,EACnB,KAAa,EACb,SAAS,EACT,QAAQ,GACT,GAAE,eAAoB,iBA8BtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,0BAA0B,CAAC;CACxC"}
1
+ {"version":3,"file":"site.d.ts","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAAO,sBAAsB,EAAC,MAAM,cAAc,CAAC;AAK1D,OAAO,EAAmC,0BAA0B,EAAY,MAAM,SAAS,CAAC;AAuChG;;;GAGG;AACH,wBAAsB,SAAS,CAAC,EAC9B,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAkB,EAClB,GAAmB,EACnB,KAAa,EACb,SAAS,EACT,QAAQ,GACT,GAAE,eAAoB,iBAuCtB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,sBAAsB,CAAC;IAElC;;OAEG;IACH,SAAS,CAAC,EAAE,0BAA0B,CAAC;CACxC"}
@@ -63,7 +63,7 @@ async function buildSite({ mkdocsYml: mkDocsYmlPath, siteDir, theme = constants_
63
63
  await doServe(mkdocsArgs, serveOpts);
64
64
  }
65
65
  else {
66
- log.info('Building site into %s (%dms)');
66
+ log.info('Building site...');
67
67
  await doBuild(mkdocsArgs, execOpts);
68
68
  let relSiteDir;
69
69
  if (siteDir) {
@@ -71,10 +71,16 @@ async function buildSite({ mkdocsYml: mkDocsYmlPath, siteDir, theme = constants_
71
71
  }
72
72
  else {
73
73
  ({ site_dir: siteDir } = await (0, fs_1.readMkDocsYml)(mkDocsYmlPath));
74
- log.debug('Found site_dir %s', siteDir);
75
- relSiteDir = (0, util_1.relative)(node_path_1.default.dirname(mkDocsYmlPath), siteDir);
74
+ if (siteDir) {
75
+ log.debug('Found site_dir %s', siteDir);
76
+ relSiteDir = (0, util_1.relative)(node_path_1.default.dirname(mkDocsYmlPath), siteDir);
77
+ }
78
+ else {
79
+ log.warn('No site_dir specified in args or %s; using default site_dir: %s', constants_1.NAME_MKDOCS_YML, constants_1.DEFAULT_SITE_DIR);
80
+ relSiteDir = (0, util_1.relative)(cwd, constants_1.DEFAULT_SITE_DIR);
81
+ }
76
82
  }
77
- log.success('Finnished building site into %s (%dms)', relSiteDir, stop());
83
+ log.success('Finished building site into %s (%dms)', relSiteDir, stop());
78
84
  }
79
85
  }
80
86
  exports.buildSite = buildSite;
@@ -1 +1 @@
1
- {"version":3,"file":"site.js","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,0DAA6B;AAC7B,+CAA0D;AAC1D,4CAAmE;AACnE,oCAAuC;AACvC,8BAAgE;AAChE,sCAAoC;AACpC,kCAAgG;AAEhG,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,QAAQ,CAAC,CAAC;AAEhC;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,OAAmC,EAAE,EACrC,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IAErC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,OAAO,IAAA,6BAAsB,EAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,OAA+B,EAAE,EACjC,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,OAAO,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,SAAS,CAAC,EAC9B,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAK,GAAG,sBAAU,EAClB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,KAAK,GAAG,KAAK,EACb,SAAS,EACT,QAAQ,MACW,EAAE;IACrB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,cAAc,CAAC,CAAC;IACvC,aAAa,GAAG,aAAa;QAC3B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC;QAC5C,CAAC,CAAC,MAAM,IAAA,kBAAa,EAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,2BAAe,SAAS,GAAG,UAAU,oBAAQ,qBAAqB,CACrF,CAAC;KACH;IACD,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACtD,IAAI,OAAO,EAAE;QACX,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KAChC;IACD,IAAI,KAAK,EAAE;QACT,0CAA0C;QAC1C,MAAM,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;KACtC;SAAM;QACL,GAAG,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAC;QACzC,MAAM,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC;QACf,IAAI,OAAO,EAAE;YACX,UAAU,GAAG,IAAA,eAAQ,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SACrC;aAAM;YACL,CAAC,EAAC,QAAQ,EAAE,OAAO,EAAC,GAAG,MAAM,IAAA,kBAAa,EAAC,aAAa,CAAC,CAAC,CAAC;YAC3D,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;YACxC,UAAU,GAAG,IAAA,eAAQ,EAAC,mBAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAQ,CAAC,CAAC;SAC9D;QACD,GAAG,CAAC,OAAO,CAAC,wCAAwC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;KAC3E;AACH,CAAC;AAtCD,8BAsCC"}
1
+ {"version":3,"file":"site.js","sourceRoot":"","sources":["../../../lib/builder/site.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;;;;AAEH,0DAA6B;AAC7B,+CAA0D;AAC1D,4CAAqF;AACrF,oCAAuC;AACvC,8BAAgE;AAChE,sCAAoC;AACpC,kCAAgG;AAEhG,MAAM,GAAG,GAAG,IAAA,kBAAS,EAAC,QAAQ,CAAC,CAAC;AAEhC;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,OAAmC,EAAE,EACrC,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IAErC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,OAAO,IAAA,6BAAsB,EAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,OAAO,CACpB,OAAiB,EAAE,EACnB,OAA+B,EAAE,EACjC,UAAmB;IAEnB,UAAU,GAAG,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;IACjD,MAAM,SAAS,GAAG,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;IACrC,GAAG,CAAC,KAAK,CAAC,4BAA4B,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC/D,OAAO,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,SAAS,CAAC,EAC9B,SAAS,EAAE,aAAa,EACxB,OAAO,EACP,KAAK,GAAG,sBAAU,EAClB,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,EACnB,KAAK,GAAG,KAAK,EACb,SAAS,EACT,QAAQ,MACW,EAAE;IACrB,MAAM,IAAI,GAAG,IAAA,gBAAS,EAAC,cAAc,CAAC,CAAC;IACvC,aAAa,GAAG,aAAa;QAC3B,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,aAAa,CAAC;QAC5C,CAAC,CAAC,MAAM,IAAA,kBAAa,EAAC,GAAG,CAAC,CAAC;IAC7B,IAAI,CAAC,aAAa,EAAE;QAClB,MAAM,IAAI,qBAAa,CACrB,kBAAkB,2BAAe,SAAS,GAAG,UAAU,oBAAQ,qBAAqB,CACrF,CAAC;KACH;IACD,MAAM,UAAU,GAAG,CAAC,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IACtD,IAAI,OAAO,EAAE;QACX,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;KAChC;IACD,IAAI,KAAK,EAAE;QACT,0CAA0C;QAC1C,MAAM,OAAO,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;KACtC;SAAM;QACL,GAAG,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC7B,MAAM,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;QACpC,IAAI,UAAU,CAAC;QACf,IAAI,OAAO,EAAE;YACX,UAAU,GAAG,IAAA,eAAQ,EAAC,GAAG,EAAE,OAAO,CAAC,CAAC;SACrC;aAAM;YACL,CAAC,EAAC,QAAQ,EAAE,OAAO,EAAC,GAAG,MAAM,IAAA,kBAAa,EAAC,aAAa,CAAC,CAAC,CAAC;YAC3D,IAAI,OAAO,EAAE;gBACX,GAAG,CAAC,KAAK,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;gBACxC,UAAU,GAAG,IAAA,eAAQ,EAAC,mBAAI,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC,CAAC;aAC7D;iBAAM;gBACL,GAAG,CAAC,IAAI,CACN,iEAAiE,EACjE,2BAAe,EACf,4BAAgB,CACjB,CAAC;gBACF,UAAU,GAAG,IAAA,eAAQ,EAAC,GAAG,EAAE,4BAAgB,CAAC,CAAC;aAC9C;SACF;QACD,GAAG,CAAC,OAAO,CAAC,uCAAuC,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,CAAC;KAC1E;AACH,CAAC;AA/CD,8BA+CC"}
@@ -126,4 +126,8 @@ export declare const LogLevelMap: {
126
126
  * Default site nav header text
127
127
  */
128
128
  export declare const DEFAULT_NAV_HEADER = "Reference";
129
+ /**
130
+ * If the user does not specify a site directory _and_ the `mkdocs.yml` doesn't either, use this dir.
131
+ */
132
+ export declare const DEFAULT_SITE_DIR = "site";
129
133
  //# sourceMappingURL=constants.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AAIjC,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,QAAQ,gBAAgB,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAClD;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AACxD;;;GAGG;AACH,eAAO,MAAM,WAAW,YAAY,CAAC;AACrC;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,SAAS,SAAS,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,YAAY,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,UAAU,aAAa,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,iBAAiB,SAAS,CAAC;AACxC;;GAEG;AACH,eAAO,MAAM,YAAY,QAAyB,CAAC;AACnD;;GAEG;AAEH,eAAO,MAAM,YAAY,EAAE,WAE1B,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,qBAAqB,QAAiD,CAAC;AAEpF;;GAEG;AACH,eAAO,MAAM,4BAA4B,QAAiC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;CAMd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC"}
1
+ {"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,QAAQ,EAAC,MAAM,SAAS,CAAC;AAIjC,OAAO,EAAC,WAAW,EAAC,MAAM,WAAW,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,QAAQ,gBAAgB,CAAC;AAEtC;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAClD;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AACpC;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,iBAAiB,iBAAiB,CAAC;AAChD;;GAEG;AACH,eAAO,MAAM,qBAAqB,qBAAqB,CAAC;AACxD;;;GAGG;AACH,eAAO,MAAM,WAAW,YAAY,CAAC;AACrC;;GAEG;AACH,eAAO,MAAM,WAAW,WAAW,CAAC;AAEpC;;GAEG;AACH,eAAO,MAAM,SAAS,SAAS,CAAC;AAEhC;;GAEG;AACH,eAAO,MAAM,YAAY,YAAY,CAAC;AAEtC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,QAAQ,QAAQ,CAAC;AAE9B;;GAEG;AACH,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,eAAe,WAAW,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,UAAU,aAAa,CAAC;AAErC;;GAEG;AACH,eAAO,MAAM,iBAAiB,SAAS,CAAC;AACxC;;GAEG;AACH,eAAO,MAAM,YAAY,QAAyB,CAAC;AACnD;;GAEG;AAEH,eAAO,MAAM,YAAY,EAAE,WAE1B,CAAC;AAEF;;GAEG;AAEH,eAAO,MAAM,qBAAqB,QAAiD,CAAC;AAEpF;;GAEG;AACH,eAAO,MAAM,4BAA4B,QAAiC,CAAC;AAE3E;;GAEG;AACH,eAAO,MAAM,qBAAqB,aAAa,CAAC;AAEhD;;GAEG;AACH,eAAO,MAAM,qBAAqB,WAAW,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,kBAAkB,OAAO,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;;CAMd,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C;;GAEG;AACH,eAAO,MAAM,gBAAgB,SAAS,CAAC"}
@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.DEFAULT_NAV_HEADER = exports.LogLevelMap = exports.DEFAULT_SERVE_HOST = exports.DEFAULT_SERVE_PORT = exports.DEFAULT_DEPLOY_REMOTE = exports.DEFAULT_DEPLOY_BRANCH = exports.DEFAULT_REL_TYPEDOC_OUT_PATH = exports.REQUIREMENTS_TXT_PATH = exports.DOCUTILS_PKG = exports.PKG_ROOT_DIR = exports.DEFAULT_LOG_LEVEL = exports.NAME_THEME = exports.NAME_ERR_EEXIST = exports.NAME_ERR_ENOENT = exports.NAME_TYPESCRIPT = exports.NAME_NPM = exports.NAME_PIP = exports.NAME_TYPEDOC = exports.NAME_MIKE = exports.NAME_MKDOCS = exports.NAME_SCHEMA = exports.NAME_REQUIREMENTS_TXT = exports.NAME_PACKAGE_JSON = exports.NAME_TYPEDOC_JSON = exports.NAME_PYTHON = exports.NAME_TSCONFIG_JSON = exports.NAME_MKDOCS_YML = exports.NAME_BIN = void 0;
6
+ exports.DEFAULT_SITE_DIR = exports.DEFAULT_NAV_HEADER = exports.LogLevelMap = exports.DEFAULT_SERVE_HOST = exports.DEFAULT_SERVE_PORT = exports.DEFAULT_DEPLOY_REMOTE = exports.DEFAULT_DEPLOY_BRANCH = exports.DEFAULT_REL_TYPEDOC_OUT_PATH = exports.REQUIREMENTS_TXT_PATH = exports.DOCUTILS_PKG = exports.PKG_ROOT_DIR = exports.DEFAULT_LOG_LEVEL = exports.NAME_THEME = exports.NAME_ERR_EEXIST = exports.NAME_ERR_ENOENT = exports.NAME_TYPESCRIPT = exports.NAME_NPM = exports.NAME_PIP = exports.NAME_TYPEDOC = exports.NAME_MIKE = exports.NAME_MKDOCS = exports.NAME_SCHEMA = exports.NAME_REQUIREMENTS_TXT = exports.NAME_PACKAGE_JSON = exports.NAME_TYPEDOC_JSON = exports.NAME_PYTHON = exports.NAME_TSCONFIG_JSON = exports.NAME_MKDOCS_YML = exports.NAME_BIN = void 0;
7
7
  /**
8
8
  * Constants used across various modules in this package
9
9
  * @module
@@ -134,4 +134,8 @@ exports.LogLevelMap = {
134
134
  * Default site nav header text
135
135
  */
136
136
  exports.DEFAULT_NAV_HEADER = 'Reference';
137
+ /**
138
+ * If the user does not specify a site directory _and_ the `mkdocs.yml` doesn't either, use this dir.
139
+ */
140
+ exports.DEFAULT_SITE_DIR = 'site';
137
141
  //# sourceMappingURL=constants.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":";;;;;;AAAA;;;GAGG;AACH,qCAAiC;AACjC,qCAAqC;AACrC,6CAAmC;AACnC,0DAA6B;AAG7B;;GAEG;AACU,QAAA,QAAQ,GAAG,aAAa,CAAC;AAEtC;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,kBAAkB,GAAG,eAAe,CAAC;AAClD;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AACpC;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AACxD;;;GAGG;AACU,QAAA,WAAW,GAAG,SAAS,CAAC;AACrC;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AAEpC;;GAEG;AACU,QAAA,SAAS,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACU,QAAA,YAAY,GAAG,SAAS,CAAC;AAEtC;;;;;GAKG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,UAAU,GAAG,UAAU,CAAC;AAErC;;GAEG;AACU,QAAA,iBAAiB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACU,QAAA,YAAY,GAAG,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACnD;;GAEG;AAEU,QAAA,YAAY,GAAgB,IAAI,CAAC,KAAK,CACjD,IAAA,sBAAY,EAAC,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,yBAAiB,CAAC,EAAE,MAAM,CAAC,CACjE,CAAC;AAEF;;GAEG;AAEU,QAAA,qBAAqB,GAAG,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,6BAAqB,CAAC,CAAC;AAEpF;;GAEG;AACU,QAAA,4BAA4B,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3E;;GAEG;AACU,QAAA,qBAAqB,GAAG,UAAU,CAAC;AAEhD;;GAEG;AACU,QAAA,qBAAqB,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC;AAE9C;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,kBAAQ,CAAC,MAAM;IACvB,KAAK,EAAE,kBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,kBAAQ,CAAC,KAAK;CACb,CAAC;AAEX;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC"}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../lib/constants.ts"],"names":[],"mappings":";;;;;;AAAA;;;GAGG;AACH,qCAAiC;AACjC,qCAAqC;AACrC,6CAAmC;AACnC,0DAA6B;AAG7B;;GAEG;AACU,QAAA,QAAQ,GAAG,aAAa,CAAC;AAEtC;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,kBAAkB,GAAG,eAAe,CAAC;AAClD;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AACpC;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,iBAAiB,GAAG,cAAc,CAAC;AAChD;;GAEG;AACU,QAAA,qBAAqB,GAAG,kBAAkB,CAAC;AACxD;;;GAGG;AACU,QAAA,WAAW,GAAG,SAAS,CAAC;AACrC;;GAEG;AACU,QAAA,WAAW,GAAG,QAAQ,CAAC;AAEpC;;GAEG;AACU,QAAA,SAAS,GAAG,MAAM,CAAC;AAEhC;;GAEG;AACU,QAAA,YAAY,GAAG,SAAS,CAAC;AAEtC;;;;;GAKG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,QAAQ,GAAG,KAAK,CAAC;AAE9B;;GAEG;AACU,QAAA,eAAe,GAAG,YAAY,CAAC;AAE5C;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,eAAe,GAAG,QAAQ,CAAC;AAExC;;GAEG;AACU,QAAA,UAAU,GAAG,UAAU,CAAC;AAErC;;GAEG;AACU,QAAA,iBAAiB,GAAG,MAAM,CAAC;AACxC;;GAEG;AACU,QAAA,YAAY,GAAG,YAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AACnD;;GAEG;AAEU,QAAA,YAAY,GAAgB,IAAI,CAAC,KAAK,CACjD,IAAA,sBAAY,EAAC,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,yBAAiB,CAAC,EAAE,MAAM,CAAC,CACjE,CAAC;AAEF;;GAEG;AAEU,QAAA,qBAAqB,GAAG,mBAAI,CAAC,IAAI,CAAC,oBAAY,EAAE,6BAAqB,CAAC,CAAC;AAEpF;;GAEG;AACU,QAAA,4BAA4B,GAAG,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AAE3E;;GAEG;AACU,QAAA,qBAAqB,GAAG,UAAU,CAAC;AAEhD;;GAEG;AACU,QAAA,qBAAqB,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACU,QAAA,kBAAkB,GAAG,IAAI,CAAC;AAEvC;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC;AAE9C;;GAEG;AACU,QAAA,WAAW,GAAG;IACzB,MAAM,EAAE,kBAAQ,CAAC,MAAM;IACvB,KAAK,EAAE,kBAAQ,CAAC,KAAK;IACrB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,IAAI,EAAE,kBAAQ,CAAC,IAAI;IACnB,KAAK,EAAE,kBAAQ,CAAC,KAAK;CACb,CAAC;AAEX;;GAEG;AACU,QAAA,kBAAkB,GAAG,WAAW,CAAC;AAE9C;;GAEG;AACU,QAAA,gBAAgB,GAAG,MAAM,CAAC"}
@@ -7,7 +7,7 @@
7
7
 
8
8
  import path from 'node:path';
9
9
  import {exec, TeenProcessExecOptions} from 'teen_process';
10
- import {NAME_BIN, NAME_MKDOCS_YML, NAME_THEME} from '../constants';
10
+ import {DEFAULT_SITE_DIR, NAME_BIN, NAME_MKDOCS_YML, NAME_THEME} from '../constants';
11
11
  import {DocutilsError} from '../error';
12
12
  import {findMkDocsYml, readMkDocsYml, whichMkDocs} from '../fs';
13
13
  import {getLogger} from '../logger';
@@ -80,17 +80,26 @@ export async function buildSite({
80
80
  // unsure about how SIGHUP is handled here
81
81
  await doServe(mkdocsArgs, serveOpts);
82
82
  } else {
83
- log.info('Building site into %s (%dms)');
83
+ log.info('Building site...');
84
84
  await doBuild(mkdocsArgs, execOpts);
85
85
  let relSiteDir;
86
86
  if (siteDir) {
87
87
  relSiteDir = relative(cwd, siteDir);
88
88
  } else {
89
89
  ({site_dir: siteDir} = await readMkDocsYml(mkDocsYmlPath));
90
- log.debug('Found site_dir %s', siteDir);
91
- relSiteDir = relative(path.dirname(mkDocsYmlPath), siteDir!);
90
+ if (siteDir) {
91
+ log.debug('Found site_dir %s', siteDir);
92
+ relSiteDir = relative(path.dirname(mkDocsYmlPath), siteDir);
93
+ } else {
94
+ log.warn(
95
+ 'No site_dir specified in args or %s; using default site_dir: %s',
96
+ NAME_MKDOCS_YML,
97
+ DEFAULT_SITE_DIR
98
+ );
99
+ relSiteDir = relative(cwd, DEFAULT_SITE_DIR);
100
+ }
92
101
  }
93
- log.success('Finnished building site into %s (%dms)', relSiteDir, stop());
102
+ log.success('Finished building site into %s (%dms)', relSiteDir, stop());
94
103
  }
95
104
  }
96
105
 
package/lib/constants.ts CHANGED
@@ -153,3 +153,8 @@ export const LogLevelMap = {
153
153
  * Default site nav header text
154
154
  */
155
155
  export const DEFAULT_NAV_HEADER = 'Reference';
156
+
157
+ /**
158
+ * If the user does not specify a site directory _and_ the `mkdocs.yml` doesn't either, use this dir.
159
+ */
160
+ export const DEFAULT_SITE_DIR = 'site';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appium/docutils",
3
- "version": "0.3.8",
3
+ "version": "0.3.9",
4
4
  "description": "Documentation generation utilities for Appium and related projects",
5
5
  "keywords": [
6
6
  "automation",
@@ -83,5 +83,5 @@
83
83
  "publishConfig": {
84
84
  "access": "public"
85
85
  },
86
- "gitHead": "b9ef676b73a0542a7895e74db0a709c1650eba26"
86
+ "gitHead": "a4a816efeb90f199a1f9d19b196df32ae6701630"
87
87
  }