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

Unified 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | pkg/docgen/bin/dartdoc.py » ('j') | pkg/docgen/bin/dartdoc.py » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: pkg/docgen/README.md
diff --git a/pkg/docgen/README.md b/pkg/docgen/README.md
index 0e3b3daf4ae87e4e978e51c9c73e98c90e6d16db..ab4a650df0c8f65e49f072613fa1338edf34f3f6 100644
--- a/pkg/docgen/README.md
+++ b/pkg/docgen/README.md
@@ -47,8 +47,6 @@ To get more information on how to use the outputted documentation with
dartdoc-viewer, please take a look at the
[dartdoc-viewer documentation][dartdoc-viewer].
-[dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer"
-
#### Uploading to Cloud Storage
To push new files to Google Cloud Storage for use by the viewer, use the
@@ -63,3 +61,41 @@ the documentation. Run `python gsutil ls gs://dartlang-docgen` to see the file
layout. Follow this convention and update a new VERSION file when uploading
a new version of documentation. You can see the format of the VERSION file
by running `python gsutil cat gs://dartlang-docgen/VERSION`.
+
+### Viewing Generated Documentation
+
+Docgen's generated YAML files can be used by the
+[Dart Documentation Viewer][dartdoc-viewer] for easy viewing and navigation
+through a project.
+
+---
+
+#### Using dartdoc.py
+
+The `dartdoc.py` script located in the `bin` directory is a useful tool for
+creating documentation for a Dart project and running it locally.
+
+##### Setup
+
+The `dartdoc.py` script makes use of the
+[Google App Engine SDK for Python][GAE]'s development server to serve the
+documentation viewer. Install a recent version of the SDK before running
+`dartdoc.py`.
+
+##### Running dartdoc.py
+
+Run `python dartdoc.py -h` from the `bin` directory for all available options.
+The two required options are as follows:
+
+ 1. The `--options` option describes any options being passed into `docgen.dart`.
+ If more then one option is desired, separate the options with a space
+ (ex. `--options='--include-sdk files'`).
+ 2. The `--gae-sdk` option gives the absolute path to the
+ [Google App Engine SDK][GAE].
+
+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.
+will serve files generated by `docgen.dart` in your browser.
+
+[dartdoc-viewer]: https://github.com/dart-lang/dartdoc-viewer "Dartdoc-Viewer"
+[GAE]: https://developers.google.com/appengine/downloads#Google_App_Engine_SDK_for_Python "Google App Engine SDK for Python"
+
« 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