Fcalva/cyclone
1
0
Fork 0
mirror of https://github.com/justinethier/cyclone.git synced 2025-05-19 05:39:17 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Added documentation

Browse source
This commit is contained in:
Justin Ethier 2016-10-11 20:43:30 -04:00
parent 7ea9812f71
commit 52bfdccb89
2 changed files with 16 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
scripts/README.md Normal file
View file

@ -0,0 +1,10 @@
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`
Use this script to copy any API documentation changes to the Jekyll webpage (gh-pages).
# `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`.

7
scripts/api-update.sh
View file

@ -5,7 +5,12 @@
# Copyright (c) 2014-2016, Justin Ethier
# All rights reserved.
#
# Copy API documentation to the Jekyll webpage (gh-pages)
# Purpose
# Use this script to copy API documentation changes to the Jekyll webpage (gh-pages).
#
# Usage
# Run this script from the main directory of the repo:
# $ ./scripts/api-update.sh
#
TMP=/tmp/cyclone-docs