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

Update dartdoc to 0.28.1+1 and add parameters for source-code linking (#27511)

Browse Source
This commit is contained in:
Janice Collins 2019-02-04 14:40:22 -08:00 committed by GitHub
parent f026b193cc
commit 328c73e66d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
dev/bots/docs.sh
View File

@ -104,7 +104,7 @@ if [[ -d "$FLUTTER_PUB_CACHE" ]]; then
fi
# Install and activate dartdoc.
"$PUB" global activate dartdoc 0.28.0
"$PUB" global activate dartdoc 0.28.1+1
# This script generates a unified doc set, and creates
# a custom index.html, placing everything into dev/docs/doc.

18
dev/tools/dartdoc.dart
View File

@ -126,6 +126,9 @@ Future<void> main(List<String> arguments) async {
} else {
dartdocBaseArgs.add('--no-validate-links');
}
dartdocBaseArgs.addAll(<String>['--link-to-source-excludes', '../../bin/cache',
'--link-to-source-root', '../..',
'--link-to-source-uri-template', 'https://github.com/flutter/flutter/blob/${gitRevision()}/%f%#L%l%']);
// Generate the documentation.
// We don't need to exclude flutter_tools in this list because it's not in the
// recursive dependencies of the package defined at dev/docs/pubspec.yaml
@ -250,24 +253,25 @@ String getBranchName() {
return gitBranchMatch == null ? '' : gitBranchMatch.group(1).split('...').first;
}
void createFooter(String footerPath) {
String gitRevision() {
const int kGitRevisionLength = 10;
final ProcessResult gitResult = Process.runSync('git', <String>['rev-parse', 'HEAD']);
if (gitResult.exitCode != 0)
throw 'git rev-parse exit with non-zero exit code: ${gitResult.exitCode}';
String gitRevision = gitResult.stdout.trim();
final String gitRevision = gitResult.stdout.trim();
return gitRevision.length > kGitRevisionLength ? gitRevision.substring(0, kGitRevisionLength) : gitRevision;
}
void createFooter(String footerPath) {
final String timestamp = DateFormat('yyyy-MM-dd HH:mm').format(DateTime.now());
final String gitBranch = getBranchName();
final String gitBranchOut = gitBranch.isEmpty ? '' : '• </span class="no-break">$gitBranch</span>';
gitRevision = gitRevision.length > kGitRevisionLength ? gitRevision.substring(0, kGitRevisionLength) : gitRevision;
final String timestamp = DateFormat('yyyy-MM-dd HH:mm').format(DateTime.now());
File(footerPath).writeAsStringSync(<String>[
'• </span class="no-break">$timestamp<span>',
'• </span class="no-break">$gitRevision</span>',
'• </span class="no-break">${gitRevision()}</span>',
gitBranchOut].join(' '));
}