Skip to content

Commit 4adcd59

Browse files
committed
Add API generation script
1 parent ef6ce53 commit 4adcd59

File tree

3 files changed

+40
-0
lines changed

3 files changed

+40
-0
lines changed

Gemfile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,9 @@ gem 'github-pages'
55
group :scripts do
66
gem 'mgem'
77
gem 'git'
8+
9+
# API Docs
10+
gem 'yard-mruby'
11+
gem 'yard-coderay'
812
end
13+

Gemfile.lock

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ GEM
55
blankslate (2.1.2.4)
66
classifier (1.3.4)
77
fast-stemmer (>= 1.0.0)
8+
coderay (1.1.0)
89
colorator (0.1)
910
commander (4.1.5)
1011
highline (~> 1.6.11)
@@ -56,6 +57,12 @@ GEM
5657
toml (0.1.0)
5758
parslet (~> 1.5.0)
5859
yajl-ruby (1.1.0)
60+
yard (0.8.7.6)
61+
yard-coderay (0.1.0)
62+
coderay
63+
yard
64+
yard-mruby (0.2.0)
65+
yard
5966

6067
PLATFORMS
6168
ruby
@@ -64,3 +71,8 @@ DEPENDENCIES
6471
git
6572
github-pages
6673
mgem
74+
yard-coderay
75+
yard-mruby
76+
77+
BUNDLED WITH
78+
1.10.6

gen/api

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#!/bin/bash
2+
3+
set -euo pipefail
4+
IFS=$'\n\t'
5+
6+
if [ -d "mruby" ]; then
7+
pushd mruby
8+
# Fetch updated sources
9+
git pull
10+
popd
11+
else
12+
# Clone a fresh mruby repo
13+
git clone https://github.com/mruby/mruby.git
14+
fi
15+
16+
# Clean old docs
17+
rm -rf docs/api
18+
19+
# Generate docs
20+
pushd mruby
21+
bundle exec mrbdoc -o ../docs/api
22+
popd
23+
touch docs/api/.nojekyll

0 commit comments

Comments
 (0)