Add header comments

This commit is contained in:
Justin Ethier 2016-10-03 17:26:01 -04:00
parent acbf76e66c
commit b3566673d3
2 changed files with 20 additions and 1 deletions

View file

@ -1,4 +1,12 @@
#!/bin/bash
# Cyclone Scheme
# https://github.com/justinethier/cyclone
#
# Copyright (c) 2014-2016, Justin Ethier
# All rights reserved.
#
# Copy API documentation to the Jekyll webpage (gh-pages)
#
TMP=/tmp/cyclone-docs
@ -11,6 +19,7 @@ git checkout gh-pages
cp -r $TMP/api/ docs/
cp $TMP/API.md docs/
# Clean up main API page
echo "$(tail -n +2 docs/API.md)" > docs/API.md
sed -i -- 's/.md//g' docs/API.md
sed -i -- '1s;^;---\n\n;' docs/API.md
@ -18,7 +27,10 @@ sed -i -- '1s;^;title: API\n;' docs/API.md
sed -i -- '1s;^;layout: main\n;' docs/API.md
sed -i -- '1s;^;---\n;' docs/API.md
# find . | grep md
# On-off replacements
sed -i -- 's/#-heap/#heap/g' docs/api/srfi/18.md
# Add Jekyll header and do global replacements
cd docs/api
for fn in `find . | grep md`; do
echo "processing file: $fn"

View file

@ -1,5 +1,12 @@
#!/bin/bash
# Cyclone Scheme
# https://github.com/justinethier/cyclone
#
# Copyright (c) 2014-2016, Justin Ethier
# All rights reserved.
#
# Generate a sorted list of functions/variables from the API documentation.
#
API=api-index.txt
TMP=/tmp/api-index.txt
cyclone scripts/convert-doc-index.scm