firka/flutter
firka/flutter
5
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix Material docs (#6781)

Browse Source 
...by reverting us to an earlier dartdoc package.

Also I added a sanity test to make sure that we don't regress this again.
This commit is contained in:
Ian Hickson 2016-11-09 15:16:13 -08:00 committed by GitHub
parent 49b5701224
commit 690ec45095
2 changed files with 19 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
dev/bots/docs.sh
View File

@ -2,13 +2,13 @@
set -e set -e
# Install dartdoc. # Install dartdoc.
pub global activate dartdoc 0.9.7+6 # Versions after 0.9.7+1 suffer from https://github.com/dart-lang/dartdoc/issues/1236
# so are we pinned to this old version until that bug is fixed.
# Generate flutter docs into dev/docs/doc/api/. pub global activate dartdoc 0.9.7+1
(cd dev/tools; pub get)
# 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)
FLUTTER_ROOT=$PWD dart dev/tools/dartdoc.dart FLUTTER_ROOT=$PWD dart dev/tools/dartdoc.dart
# Ensure google webmaster tools can verify our site. # Ensure google webmaster tools can verify our site.

15
dev/tools/dartdoc.dart
View File

@ -82,9 +82,24 @@ dependencies:
if (exitCode != 0) if (exitCode != 0)
exit(exitCode); exit(exitCode);
sanityCheckDocs();
createIndexAndCleanup(); createIndexAndCleanup();
} }
void sanityCheckDocs() {
List<String> canaries = <String>[
'$kDocRoot/api/material/Material-class.html',
'$kDocRoot/api/material/Tooltip-class.html',
'$kDocRoot/api/widgets/Widget-class.html',
'$kDocRoot/api/dart-ui/Canvas-class.html',
];
for (String canary in canaries) {
if (!new File(canary).existsSync())
throw new Exception('Missing "$canary", which probably means the documentation failed to build correctly.');
}
}
/// Creates a custom index.html because we try to maintain old /// Creates a custom index.html because we try to maintain old
/// paths. Cleanup unused index.html files no longer needed. /// paths. Cleanup unused index.html files no longer needed.
void createIndexAndCleanup() { void createIndexAndCleanup() {