mediawiki-extensions-Visual.../bin/generateDocs.sh

#!/usr/bin/env bash
set -e

REPO_DIR=$(cd $(dirname $0)/..; pwd)

# Disable parallel processing which seems to be causing problems under Ruby 1.8
jsduck --config $REPO_DIR/.docs/config.json --processes 0

ln -s ../lib $REPO_DIR/docs/lib
Add bin/ directory with updateStaticLoaders and generateDocs Adding a symlink in .docs/generate.sh because of Jenkins and possibly other uses. Change-Id: Ieb56852d0d0b978fbc1cbb873204d9e457cf969c 2013-10-22 21:51:51 +00:00			`#!/usr/bin/env bash`
generateDocs.sh: Simplify * Make more like mediawiki-core's mwjsduckgen. - Use bash set -e to have the script abort early when any part of it fails (especially the jsduck command). - Since it will abort early, we don't need the 'test' for the symlink. If jsduck succeeded, it will have re-created the docs directory and thus not have the symlink yet. - Don't "cd" into anything from the script, simply use absolute paths instead. Both jsduck and ln support this. Change-Id: I03c02d590e0f696c78da87ff638bb407e48a7cd7 2014-05-03 19:16:24 +00:00			`set -e`
Add bin/ directory with updateStaticLoaders and generateDocs Adding a symlink in .docs/generate.sh because of Jenkins and possibly other uses. Change-Id: Ieb56852d0d0b978fbc1cbb873204d9e457cf969c 2013-10-22 21:51:51 +00:00
generateDocs.sh: Simplify * Make more like mediawiki-core's mwjsduckgen. - Use bash set -e to have the script abort early when any part of it fails (especially the jsduck command). - Since it will abort early, we don't need the 'test' for the symlink. If jsduck succeeded, it will have re-created the docs directory and thus not have the symlink yet. - Don't "cd" into anything from the script, simply use absolute paths instead. Both jsduck and ln support this. Change-Id: I03c02d590e0f696c78da87ff638bb407e48a7cd7 2014-05-03 19:16:24 +00:00			`REPO_DIR=$(cd $(dirname $0)/..; pwd)`
jsduck: Fix script loading issues with eg-iframe in production It works locally because it can just nagivate to ../lib/ve. In production however we need docs/ to be standalone so that we can publish it without needing a subdirectory at: https://docs.wikimedia.org/VisualEditor/master/. For local usage this will be a symlink that still points to the sibling directory (but using a symlink instead of a ../ path). In production we can then instruct jenkins to replace that symlink with an actual copy of lib/. As long as the generated path references in the HTML remain the same. Follows-up 88c488887214, which broke the publication of the docs in Jenkins as it changed references from modules/ to ../modules/ for the eg-iframe. This works locally, but broke in Jenkins as it was relying on the copying of modules/ to docs/modules/ being enough to make it work). Change-Id: I10eaa5424d172932b29774a0f03d511d555fd121 2014-01-16 20:31:15 +00:00
generateDocs.sh: Simplify * Make more like mediawiki-core's mwjsduckgen. - Use bash set -e to have the script abort early when any part of it fails (especially the jsduck command). - Since it will abort early, we don't need the 'test' for the symlink. If jsduck succeeded, it will have re-created the docs directory and thus not have the symlink yet. - Don't "cd" into anything from the script, simply use absolute paths instead. Both jsduck and ln support this. Change-Id: I03c02d590e0f696c78da87ff638bb407e48a7cd7 2014-05-03 19:16:24 +00:00			`# Disable parallel processing which seems to be causing problems under Ruby 1.8`
			`jsduck --config $REPO_DIR/.docs/config.json --processes 0`
Add bin/ directory with updateStaticLoaders and generateDocs Adding a symlink in .docs/generate.sh because of Jenkins and possibly other uses. Change-Id: Ieb56852d0d0b978fbc1cbb873204d9e457cf969c 2013-10-22 21:51:51 +00:00
generateDocs.sh: Simplify * Make more like mediawiki-core's mwjsduckgen. - Use bash set -e to have the script abort early when any part of it fails (especially the jsduck command). - Since it will abort early, we don't need the 'test' for the symlink. If jsduck succeeded, it will have re-created the docs directory and thus not have the symlink yet. - Don't "cd" into anything from the script, simply use absolute paths instead. Both jsduck and ln support this. Change-Id: I03c02d590e0f696c78da87ff638bb407e48a7cd7 2014-05-03 19:16:24 +00:00			`ln -s ../lib $REPO_DIR/docs/lib`