| OLD | NEW |
| 1 docgen | 1 docgen |
| 2 ====== | 2 ====== |
| 3 | 3 |
| 4 A documentation generator for Dart. | 4 A documentation generator for Dart. |
| 5 - - - | 5 - - - |
| 6 The docgen tool takes in a file or directory as input and produces documentation | 6 The docgen tool takes in a file or directory as input and produces documentation |
| 7 for all `.dart` file it finds as YAML or JSON files. This outputs information | 7 for all `.dart` file it finds as YAML or JSON files. This outputs information |
| 8 about all classes, variables, functions, and methods defined in the library and | 8 about all classes, variables, functions, and methods defined in the library and |
| 9 its imported libraries. | 9 its imported libraries. |
| 10 | 10 |
| 11 ### Quick Start: Common Commands |
| 12 |
| 13 While standing in the `bin` directory: |
| 14 |
| 15 `dartdoc.py` generates all documentation and runs a local server with your html |
| 16 pages. |
| 17 |
| 18 `dartdoc.py -d` ONLY generates documentation for the SDK and all packages (no |
| 19 html pages generated and no server). |
| 20 |
| 21 `dartdoc.py -d -o package/to/document` ONLY generates documenation for the |
| 22 specified package. |
| 23 |
| 11 ### Generating files & uploading to Cloud Storage | 24 ### Generating files & uploading to Cloud Storage |
| 12 | 25 |
| 13 The viewer uses YAML files generated by the docgen package as the data | 26 The viewer uses YAML files generated by the docgen package as the data |
| 14 being displayed. These files are stored in Google Cloud Storage. | 27 being displayed. These files are stored in Google Cloud Storage. |
| 15 | 28 |
| 16 - Run `python upload_docgen.py` to generate these files and upload them to | 29 - Run `python upload_docgen.py` to generate these files and upload them to |
| 17 Cloud Storage as a new version. | 30 Cloud Storage as a new version. |
| 18 - - - | 31 - - - |
| 19 These tasks can be done separately if necessary: | 32 These tasks can be done separately if necessary: |
| 20 | 33 |
| (...skipping 89 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 110 (ex. `--options='--include-sdk files'`). | 123 (ex. `--options='--include-sdk files'`). |
| 111 2. The `--gae-sdk` option gives the absolute path to the | 124 2. The `--gae-sdk` option gives the absolute path to the |
| 112 [Google App Engine SDK][GAE]. | 125 [Google App Engine SDK][GAE]. |
| 113 | 126 |
| 114 Running `python dartdoc.py --options=<docgen options> --gae-sdk=<path to SDK>` | 127 Running `python dartdoc.py --options=<docgen options> --gae-sdk=<path to SDK>` |
| 115 will serve files generated by `docgen.dart` in your browser. | 128 will serve files generated by `docgen.dart` in your browser. |
| 116 | 129 |
| 117 [dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer" | 130 [dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer" |
| 118 [GAE]: https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_f
or_Python "Google App Engine SDK for Python" | 131 [GAE]: https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_f
or_Python "Google App Engine SDK for Python" |
| 119 | 132 |
| OLD | NEW |