Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(504)

Side by Side Diff: pkg/docgen/README.md

Issue 22488017: Added script to run local files on App Engine (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 7 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« no previous file with comments | « no previous file | pkg/docgen/bin/dartdoc.py » ('j') | pkg/docgen/bin/dartdoc.py » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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
(...skipping 29 matching lines...) Expand all
40 40
41 ###### Output Directory 41 ###### Output Directory
42 Documented libraries will be located at bin/docs in either YAML or JSON format 42 Documented libraries will be located at bin/docs in either YAML or JSON format
43 depending on options specified. There will also be a library_list.txt, 43 depending on options specified. There will also be a library_list.txt,
44 containing a list of all the libraries inside the docs folder. 44 containing a list of all the libraries inside the docs folder.
45 45
46 To get more information on how to use the outputted documentation with 46 To get more information on how to use the outputted documentation with
47 dartdoc-viewer, please take a look at the 47 dartdoc-viewer, please take a look at the
48 [dartdoc-viewer documentation][dartdoc-viewer]. 48 [dartdoc-viewer documentation][dartdoc-viewer].
49 49
50 [dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer"
51
52 #### Uploading to Cloud Storage 50 #### Uploading to Cloud Storage
53 51
54 To push new files to Google Cloud Storage for use by the viewer, use the 52 To push new files to Google Cloud Storage for use by the viewer, use the
55 `gsutil` tool located at third_party/gsutil/gsutil in the Dart repository. 53 `gsutil` tool located at third_party/gsutil/gsutil in the Dart repository.
56 54
57 - Run `python gsutil -m cp -q -a public-read -r <folder> gs://dartlang-docgen` 55 - Run `python gsutil -m cp -q -a public-read -r <folder> gs://dartlang-docgen`
58 to upload the specified folder to the viewer's bucket. Be sure to also upload 56 to upload the specified folder to the viewer's bucket. Be sure to also upload
59 a new VERSION file if the uploaded folder is to be used.** 57 a new VERSION file if the uploaded folder is to be used.**
60 58
61 **Note that the bucket contains several numbered folders for each version of 59 **Note that the bucket contains several numbered folders for each version of
62 the documentation. Run `python gsutil ls gs://dartlang-docgen` to see the file 60 the documentation. Run `python gsutil ls gs://dartlang-docgen` to see the file
63 layout. Follow this convention and update a new VERSION file when uploading 61 layout. Follow this convention and update a new VERSION file when uploading
64 a new version of documentation. You can see the format of the VERSION file 62 a new version of documentation. You can see the format of the VERSION file
65 by running `python gsutil cat gs://dartlang-docgen/VERSION`. 63 by running `python gsutil cat gs://dartlang-docgen/VERSION`.
64
65 ### Viewing Generated Documentation
66
67 Docgen's generated YAML files can be used by the
68 [Dart Documentation Viewer][dartdoc-viewer] for easy viewing and navigation
69 through a project.
70
71 ---
72
73 #### Using dartdoc.py
74
75 The `dartdoc.py` script located in the `bin` directory is a useful tool for
76 creating documentation for a Dart project and running it locally.
77
78 ##### Setup
79
80 The `dartdoc.py` script makes use of the
81 [Google App Engine SDK for Python][GAE]'s development server to serve the
82 documentation viewer. Install a recent version of the SDK before running
83 `dartdoc.py`.
84
85 ##### Running dartdoc.py
86
87 Run `python dartdoc.py -h` from the `bin` directory for all available options.
88 The two required options are as follows:
89
90 1. The `--options` option describes any options being passed into `docgen.dart` .
91 If more then one option is desired, separate the options with a space
92 (ex. `--options='--include-sdk files'`).
93 2. The `--gae-sdk` option gives the absolute path to the
94 [Google App Engine SDK][GAE].
95
96 Running `python dartdoc.py --options=<docgen options> --gae-sdk=<path to SDK>`
Emily Fortuna 2013/08/12 17:04:05 You've explained all the information on how to use
Tate Mandel 2013/08/12 20:24:04 Done.
97 will serve files generated by `docgen.dart` in your browser.
98
99 [dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer"
100 [GAE]: https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_f or_Python "Google App Engine SDK for Python"
101
OLDNEW
« no previous file with comments | « no previous file | pkg/docgen/bin/dartdoc.py » ('j') | pkg/docgen/bin/dartdoc.py » ('J')

Powered by Google App Engine
This is Rietveld 408576698