cyclone/scripts/README.md
2016-10-11 20:43:30 -04:00

10 lines
482 B
Markdown

This directory contains the following scripts. All of the other files in this folder are helper scripts and should not be run directly.
# [`api-update.sh`](api-update.sh)
Use this script to copy any API documentation changes to the Jekyll webpage (gh-pages).
# [`generate-doc-index.sh`](generate-doc-index.sh)
Generate a sorted list of functions/variables from the API documentation. The output can then be manually edited into the index section of [`API.md`](../docs/API.md).