Module docs 

The documentation the model reads about yapi: the yapi book and pi’s README, docs and examples, as each release’s yapi-docs.tar.gz packs them. install.sh unpacks the release’s copy into <agent dir>/docs, and yapi downloads it on its first run when installed another way.

Structs

Locations

Where the model reads the docs: the local copy in the agent directory when it documents this version, else the published pages.

Functions

download

Downloads this version’s docs from the release in releases into <agent_dir>/docs, unless the docs there are this version’s. The archive must match its published SHA-256. It is unpacked beside the old copy, which it then replaces.

releases_url

The releases page yapi downloads its docs from and checks for a newer version, without a trailing slash: YAPI_RELEASES_URL, which install.sh reads too, else GitHub’s.