mirror of
https://github.com/dart-lang/sdk
synced 2024-11-05 18:22:09 +00:00
1c8f571f76
Dartdoc > 0.18.1 allows generation of source code links to documented objects. Enable this for the Dart SDK build. Change-Id: Ib385d3e51f6f5852f37e591d7a60ba7b4e7f93c1 Reviewed-on: https://dart-review.googlesource.com/c/92303 Reviewed-by: Alexander Thomas <athom@google.com> Commit-Queue: Janice Collins <jcollins@google.com>
40 lines
1.1 KiB
Python
Executable file
40 lines
1.1 KiB
Python
Executable file
#!/usr/bin/env python
|
|
# Copyright (c) 2019, the Dart project authors. Please see the AUTHORS file
|
|
# for details. All rights reserved. Use of this source code is governed by a
|
|
# BSD-style license that can be found in the LICENSE file.
|
|
|
|
import argparse
|
|
import sys
|
|
import utils
|
|
|
|
def ParseArgs(args):
|
|
args = args[1:]
|
|
parser = argparse.ArgumentParser(
|
|
description='A script to write a custom dartdoc_options.yaml to a file')
|
|
|
|
parser.add_argument('--output', '-o',
|
|
type=str,
|
|
required=True,
|
|
help='File to write')
|
|
|
|
return parser.parse_args(args)
|
|
|
|
|
|
def Main(argv):
|
|
args = ParseArgs(argv)
|
|
# TODO(jcollins-g): switch to version numbers when github has its tags synced
|
|
revision = utils.GetGitRevision()
|
|
if revision is None:
|
|
revision = 'master'
|
|
output = '''dartdoc:
|
|
categoryOrder: ["Core", "VM", "Web"]
|
|
linkToSource:
|
|
root: '.'
|
|
uriTemplate: 'https://github.com/dart-lang/sdk/blob/%s/sdk/%%f%%#L%%l%%'
|
|
''' % revision
|
|
with open(args.output, 'w') as f:
|
|
f.write(output)
|
|
return 0
|
|
|
|
if __name__ == '__main__':
|
|
sys.exit(Main(sys.argv))
|