-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a Makefile that creates API documentation and runs unit tests
- Loading branch information
Eric James Michael Ritz
committed
Aug 18, 2013
1 parent
f773813
commit 927a1c8
Showing
3 changed files
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Do not track documentation that LuaDoc creates. | ||
docs/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
.PHONY : docs tests | ||
|
||
all: docs tests | ||
|
||
# We generate documentation via the LuaDoc tool but the directory | ||
# where we store the documents may not exist. This rule creates the | ||
# documentation directory if it is not present. LuaDoc will also spit | ||
# out a 'luadoc.css' file into the top-level directory which we do not | ||
# want to keep. This rule will delete it. | ||
docs: | ||
if test ! -d "docs/"; then mkdir "docs"; fi | ||
luadoc -d "docs/" "src/Luvent.lua" | ||
if test -f "luadoc.css"; then rm "luadoc.css"; fi | ||
|
||
tests: | ||
busted |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters