mirror of
https://github.com/sbrl/Pepperminty-Wiki.git
synced 2024-12-22 13:45:02 +00:00
Got distracted and started looking into apidoc
This commit is contained in:
parent
01bdf96d2d
commit
9ff8d2a719
2 changed files with 27 additions and 0 deletions
3
.gitignore
vendored
3
.gitignore
vendored
|
@ -29,3 +29,6 @@ build/Files/*
|
|||
|
||||
# The testing zone for the $paths
|
||||
data_test
|
||||
|
||||
# Ignore the auto-generated API docs for now
|
||||
RestApiDocs/
|
||||
|
|
24
Makefile
Normal file
24
Makefile
Normal file
|
@ -0,0 +1,24 @@
|
|||
.DEFAULT_GOAL := peppermint
|
||||
peppermint := peppermint
|
||||
docs := docs
|
||||
|
||||
.PHONY: setupApiDoc peppermint docs
|
||||
|
||||
ApiDocPresent := $(shell sh -c apidoc --help 1\>/dev/null)
|
||||
|
||||
peppermint:
|
||||
@echo [peppermint/build] Rebuilding Pepperminty Wiki
|
||||
php build.php
|
||||
|
||||
docs: setupApiDoc
|
||||
@echo [peppermint/docs] Building docs
|
||||
apidoc -f '.*\.php' -e index.php
|
||||
|
||||
setupApiDoc:
|
||||
@echo [peppermint] Checking for apiDoc
|
||||
ifndef ApiDocPresent
|
||||
@echo [peppermint] Attempting to install ApiDoc, since it wasn't detected in your PATH
|
||||
@echo [peppermint] Note that you may need to be root, and you'll need npm installed.
|
||||
npm install apidoc --global
|
||||
endif
|
||||
@echo [peppermint] Check complete
|
Loading…
Reference in a new issue