Skip to content
This repository was archived by the owner on Feb 22, 2018. It is now read-only.

chore(documentation-generation): prepare for transition from dartdoc to docgen #553

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion scripts/env.sh
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ export DART=${DART:-"$DARTSDK/bin/dart"}
export PUB=${PUB:-"$DARTSDK/bin/pub"}
export DARTANALYZER=${DARTANALYZER:-"$DARTSDK/bin/dartanalyzer"}
export DARTDOC=${DARTDOC:-"$DARTSDK/bin/dartdoc"}

export DART_DOCGEN=${DART_DOCGEN:-"$DARTSDK/bin/docgen"}

export CHROME_CANARY_BIN=${CHROME_CANARY_BIN:-"$DARTIUM"}
export CHROME_BIN=${CHROME_BIN:-"google-chrome"}
Expand Down
26 changes: 23 additions & 3 deletions scripts/generate-documentation.sh
Original file line number Diff line number Diff line change
@@ -1,8 +1,28 @@
#!/bin/bash
. $(dirname $0)/env.sh
$DARTDOC \

# Temporary during transition period from use of dartdoc to docgen.
if [ -x "$DART_DOCGEN" ]; then
# docgen seems to freeze when it processes the angular.dart files
# https://code.google.com/p/dart/issues/detail?id=16752
# so disable it for now
# DOC_CMD="$DART_DOCGEN"
# MODE_OPTION=
echo "DISABLING DOCUMENT GENERATION due to isses with docgen."
echo "https://code.google.com/p/dart/issues/detail?id=16752"
echo "----"
echo "Reporting success none-the-less during this docgen beta period."
exit 0;
elif [ -x "$DARTDOC" ]; then
DOC_CMD="$DARTDOC"
MODE_OPTION="--mode=static"
fi

echo "Generating documentation using $DOC_CMD"
"$DOC_CMD" $MODE_OPTION \
--package-root=packages/ \
--out doc \
--mode=static \
--exclude-lib=js,metadata,meta,mirrors,intl,number_symbols,number_symbol_data,intl_helpers,date_format_internal,date_symbols,angular.util \
packages/angular/angular.dart lib/mock/module.dart \
packages/angular/angular.dart lib/mock/module.dart