Commit 6d84e4aa authored by Adam Barth's avatar Adam Barth Committed by GitHub

Update Flutter to use the latest dartdoc (#7438)

Now that dart-lang/dartdoc#1236 is fixed.
parent 8f6aefa2
...@@ -2,15 +2,35 @@ ...@@ -2,15 +2,35 @@
set -e set -e
# Install dartdoc. # Install dartdoc.
# Versions after 0.9.7+1 suffer from https://github.com/dart-lang/dartdoc/issues/1236 pub global activate dartdoc 0.9.9
# so are we pinned to this old version until that bug is fixed.
pub global activate dartdoc 0.9.7+1
# This script generates a unified doc set, and creates # This script generates a unified doc set, and creates
# a custom index.html, placing everything into dev/docs/doc # a custom index.html, placing everything into dev/docs/doc
(cd dev/tools; pub get) (cd dev/tools; pub get)
FLUTTER_ROOT=$PWD dart dev/tools/dartdoc.dart FLUTTER_ROOT=$PWD dart dev/tools/dartdoc.dart
# Smoke test the docs to make sure we have all the major kinds of things.
if [[ ! -f dev/docs/doc/flutter/widgets/Widget/Widget.html ]]; then
echo 'Failed to find documentation for Widget class. Are the docs complete?'
exit 1
fi
if [[ ! -f dev/docs/doc/flutter/dart-io/File/File.html ]]; then
echo 'Failed to find documentation for File class. Are the docs complete?'
exit 1
fi
if [[ ! -f dev/docs/doc/flutter/dart-ui/Canvas/drawRect.html ]]; then
echo 'Failed to find documentation for Canvas.drawRect. Are the docs complete?'
exit 1
fi
if [[ ! -f dev/docs/doc/flutter/flutter_test/WidgetTester/pumpWidget.html ]]; then
echo 'Failed to find documentation for WidgetTester.pumpWidget. Are the docs complete?'
exit 1
fi
# Ensure google webmaster tools can verify our site. # Ensure google webmaster tools can verify our site.
cp dev/docs/google2ed1af765c529f57.html dev/docs/doc cp dev/docs/google2ed1af765c529f57.html dev/docs/doc
......
...@@ -62,16 +62,14 @@ dependencies: ...@@ -62,16 +62,14 @@ dependencies:
'global', 'run', 'dartdoc', 'global', 'run', 'dartdoc',
'--header', 'styles.html', '--header', 'styles.html',
'--header', 'analytics.html', '--header', 'analytics.html',
'--dart-sdk', '../../bin/cache/dart-sdk',
'--exclude', 'temp_doc', '--exclude', 'temp_doc',
'--favicon=favicon.ico', '--favicon=favicon.ico',
'--use-categories' '--use-categories'
]; ];
for (String libraryRef in libraryRefs()) { for (String libraryRef in libraryRefs(diskPath: true)) {
String name = path.basename(libraryRef);
args.add('--include-external'); args.add('--include-external');
args.add(name.substring(0, name.length - 5)); args.add(libraryRef);
} }
process = await Process.start('pub', args, workingDirectory: 'dev/docs'); process = await Process.start('pub', args, workingDirectory: 'dev/docs');
...@@ -145,6 +143,7 @@ List<String> findPackageNames() { ...@@ -145,6 +143,7 @@ List<String> findPackageNames() {
return findPackages().map((Directory dir) => path.basename(dir.path)).toList(); return findPackages().map((Directory dir) => path.basename(dir.path)).toList();
} }
/// Finds all packages in the Flutter SDK
List<Directory> findPackages() { List<Directory> findPackages() {
return new Directory('packages') return new Directory('packages')
.listSync() .listSync()
...@@ -158,14 +157,21 @@ List<Directory> findPackages() { ...@@ -158,14 +157,21 @@ List<Directory> findPackages() {
.toList(); .toList();
} }
Iterable<String> libraryRefs() sync* { /// Returns import or on-disk paths for all libraries in the Flutter SDK.
///
/// diskPath toggles between import paths vs. disk paths.
Iterable<String> libraryRefs({ bool diskPath: false }) sync* {
for (Directory dir in findPackages()) { for (Directory dir in findPackages()) {
String dirName = path.basename(dir.path); String dirName = path.basename(dir.path);
for (FileSystemEntity file in new Directory('${dir.path}/lib').listSync()) { for (FileSystemEntity file in new Directory('${dir.path}/lib').listSync()) {
if (file is File && file.path.endsWith('.dart')) if (file is File && file.path.endsWith('.dart')) {
if (diskPath)
yield '$dirName/lib/${path.basename(file.path)}';
else
yield '$dirName/${path.basename(file.path)}'; yield '$dirName/${path.basename(file.path)}';
} }
} }
}
} }
void printStream(Stream<List<int>> stream) { void printStream(Stream<List<int>> stream) {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment