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

Commit 99d9f2a

Browse files
naomiblackmhevery
authored andcommitted
fix(doc-gen): add docviewer flags for generating the new angulardart docs
Conflicts: scripts/generate-documentation.sh
1 parent a6fdb4c commit 99d9f2a

File tree

1 file changed

+39
-6
lines changed

1 file changed

+39
-6
lines changed

scripts/generate-documentation.sh

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,53 @@
11
#!/bin/bash
22
. $(dirname $0)/env.sh
33

4+
# Use the -d flag to set the directory for the dartdoc viewer build files
5+
while getopts ":d:" opt ; do
6+
7+
case $opt in
8+
d)
9+
DOCVIEWER_DIR=$OPTARG
10+
DOCDIR_OPTION="--out "$DOCVIEWER_DIR"/web/docs"
11+
echo "Generated docs will be output to: $DOCVIEWER_DIR/web/docs" >&2
12+
;;
13+
\?)
14+
echo "Invalid option: -$OPTARG" >&2
15+
exit 1
16+
;;
17+
:)
18+
echo "Use -d to specify the directory where the dartdoc viewer pubspec.yaml is located." >&2
19+
exit 1
20+
;;
21+
esac
22+
done
23+
24+
# Temporary change to delete the Build Status image markdown from the README (image md not supported by dartdoc-viewer)
25+
cp README.md README-orig.md
26+
cat README-orig.md | sed "1s/^AngularDart.*/AngularDart/" > README.md
27+
428
# Temporary during transition period from use of dartdoc to docgen.
529
if [ -x "$DART_DOCGEN" ]; then
630
DOC_CMD="$DART_DOCGEN"
7-
MODE_OPTION=
31+
MODE_OPTION="--start-page=angular \
32+
--exclude-lib=js,metadata,meta,mirrors,intl,number_symbols,number_symbol_data,intl_helpers,date_format_internal,date_symbols,angular.util \
33+
--no-include-sdk"
34+
835
elif [ -x "$DARTDOC" ]; then
936
DOC_CMD="$DARTDOC"
1037
MODE_OPTION="--mode=static"
1138
fi
1239

13-
echo "Generating documentation using $DOC_CMD"
14-
"$DOC_CMD" $MODE_OPTION \
40+
echo "Generating documentation using $DOC_CMD $MODE_OPTION $DOCDIR_OPTION"
41+
"$DOC_CMD" $MODE_OPTION $DOCDIR_OPTION \
1542
--package-root=packages/ \
16-
--out doc \
17-
--exclude-lib=js,metadata,meta,mirrors,intl,number_symbols,number_symbol_data,intl_helpers,date_format_internal,date_symbols,angular.util \
18-
packages/angular/angular.dart lib/mock/module.dart
43+
lib/angular.dart lib/utils.dart lib/change_detection/watch_group.dart lib/core/module.dart lib/core_dom/module.dart lib/filter/module.dart lib/directive/module.dart lib/mock/module.dart lib/perf/module.dart lib/playback/playback_data.dart lib/playback/playback_http.dart lib/routing/module.dart lib/tools/common.dart lib/tools/expression_extractor.dart lib/tools/io.dart lib/tools/io_impl.dart lib/tools/source_crawler_impl.dart lib/tools/source_metadata_extractor.dart lib/tools/template_cache_annotation.dart lib/tools/template_cache_generator.dart
1944

45+
if [ -x "$DART_DOCGEN" ]; then
46+
# Set the Version for dartdoc-viewer
47+
head CHANGELOG.md | awk 'NR==2' | sed 's/^# //' > VERSION
48+
mv VERSION $DOCVIEWER_DIR/web/docs
49+
(cd $DOCVIEWER_DIR; pub build)
2050

51+
# Revert the temp copy of the README.md file
52+
mv README-orig.md README.md
53+
fi

0 commit comments

Comments
 (0)