Skip to content

Commit

Permalink
Allow to build all the docs OOTB.
Browse files Browse the repository at this point in the history
Since 1.4.10, the html docs are generated via the marked module. when
doing the usual "make" dance, the build process stops when attempting to
generate the first html doc complaining about a missing
node_modules/.bin/marked.

This patch is a quick'n'dirty copy-pasta of the treatment applied to
load the ronn module but applied to marked. When applied against the
1.4.13 tarball it allows -- at least in a works-for-me manner -- to
generate all the docs.
  • Loading branch information
GeJ authored and isaacs committed Jun 27, 2014
1 parent 59eb112 commit 28d6217
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 1 deletion.
1 change: 1 addition & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ npm-debug.log
/test/packages/npm-test-depends-on-spark/which-spark.log
/test/packages/test-package/random-data.txt
/test/root
node_modules/marked
node_modules/ronn
node_modules/tap
node_modules/.bin
Expand Down
10 changes: 9 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ dev: install
link: uninstall
node cli.js link -f

clean: ronnclean doc-clean uninstall
clean: markedclean ronnclean doc-clean uninstall
rm -rf npmrc
node cli.js cache clean

Expand All @@ -78,12 +78,16 @@ uninstall:

doc: $(mandocs) $(htmldocs)

markedclean:
rm -rf node_modules/marked node_modules/.bin/marked .building_marked

ronnclean:
rm -rf node_modules/ronn node_modules/.bin/ronn .building_ronn

docclean: doc-clean
doc-clean:
rm -rf \
.building_marked \
.building_ronn \
html/doc \
html/api \
Expand Down Expand Up @@ -149,6 +153,10 @@ html/doc/misc/%.html: doc/misc/%.md $(html_docdeps)
scripts/doc-build.sh $< $@


marked: node_modules/.bin/marked

node_modules/.bin/marked:
node cli.js install marked --no-global

ronn: node_modules/.bin/ronn

Expand Down
26 changes: 26 additions & 0 deletions scripts/doc-build.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,32 @@ if ! [ -x node_modules/.bin/ronn ]; then
fi
fi

if ! [ -x node_modules/.bin/marked ]; then
ps=0
if [ -f .building_marked ]; then
pid=$(cat .building_marked)
ps=$(ps -p $pid | grep $pid | wc -l) || true
fi

if [ -f .building_marked ] && [ $ps != 0 ]; then
while [ -f .building_marked ]; do
sleep 1
done
else
# a race to see which make process will be the one to install marked
echo $$ > .building_marked
sleep 1
if [ $(cat .building_marked) == $$ ]; then
make node_modules/.bin/marked
rm .building_marked
else
while [ -f .building_marked ]; do
sleep 1
done
fi
fi
fi

src=$1
dest=$2
name=$(basename ${src%.*})
Expand Down

0 comments on commit 28d6217

Please sign in to comment.