Creating and uploading docs for the Dart SDK

Jump to bottom

Sam Rawlins edited this page Oct 12, 2022 · 1 revision

These are instructions to manually generate docs for the Dart SDK and upload to GCS storage to be served on api.dartlang.org.

NOTE: Permissions are required to upload to GCS. Also need to have gsutil installed.

Generate the docs for the Dart SDK

$ dartdoc --dart-sdk /pathTo/dart-sdk1.11.3 --sdk-docs --output ~/sdkDocs
  --footer /pathTo/sdk/tools/bots/dartdoc_footer.html  --rel-canonical-prefix=https://api.dartlang.org/stable

Upload the generated docs to GCS

$ cd ~/sdkDocs/doc/api
$ gsutil -m cp -a public-read -R . gs://dartlang-api-docs/gen-dartdocs/1.11.3