Commit Graph

11 Commits

Author SHA1 Message Date
Christopher Hiller
5326cb1840 chore(docutils): reorganize some build-related modules into a 'builder' subdir
Also rename a few things.  `typedoc` module is now `reference` and `mkdocs` module is now `site`.

Moved a couple things into `util` as well

The `nav` module will be in stacked PR
2023-02-06 15:28:06 -08:00
Christopher Hiller
cd72da3b3f fix(docutils): fix the docutils logger
Proxy wasn't working properly. Now it is
2023-02-06 15:27:21 -08:00
Christopher Hiller
258860f377 fix(docutils): fix --mkdocs-yml arg for validate command 2023-02-06 15:26:25 -08:00
Christopher Hiller
71e91107f9 feat(docutils): add config file support
e.g., `appium-docs.config.js` and the its ilk. Not strictly necessary, but can be useful if there are a bunch of custom paths or multiple builds.
2023-02-06 15:11:43 -08:00
Christopher Hiller
abfeb21be6 feat(docutils): implement mkdocs validation
- Better grouping of `validate` command options in `--help`
- Move some more constants into the module
- Removed the "guess" functions and replaced them with functions which use `which` to actually find the necessary executables
- Moved `isStringArray()` to `util`
- Fixed some error messages and added more
- Simplified use of `DocutilsValidator#fail()`
- Removed option for custom path to `requirements.txt`
2023-02-03 11:54:02 -08:00
Christopher Hiller
f16e6c8a16 chore(docutils): tweak some logging 2023-02-02 16:25:45 -08:00
Christopher Hiller
21eb6b59f8 fix(docutils): disallow both --no-reference and --no-site
also add a final "done" message
2023-02-02 16:25:45 -08:00
Christopher Hiller
53b60bc3bb feat(docutils): add a --no-reference-header option 2023-02-02 16:25:45 -08:00
Christopher Hiller
4f457468bb feat(docutils): do not fail on first validation error
This modifies the validator to collect all of the errors from validation (except those that are "unexpected" though not _so_ unexpected that I did not account for them; stuff like "unparseable output from `pip list --json`") and display them as they happen without aborting the entire validation process.
2023-02-02 16:25:45 -08:00
Christopher Hiller
082197bd2b feat(docutils): enable updating of mkdocs nav based on commands
- also fix bad arg names
2023-02-02 16:25:45 -08:00
Christopher Hiller
ccf5d3a638 chore(typedoc): refactor CLI cmds into separate modules 2023-02-02 16:25:45 -08:00