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

Unified Diff: pkg/docgen/README.md

Issue 78713004: Expose exported classes as well. (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 7 years, 1 month 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/lib/docgen.dart » ('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 ff0fac70dbbf84391adad6c3d2c0d2334f3323f9..95ee68a3956b5fd5c7c11ab1a82dc920fa86c14b 100644
--- a/pkg/docgen/README.md
+++ b/pkg/docgen/README.md
@@ -10,7 +10,7 @@ its imported libraries.
### Quick Start: Common Commands
-While standing in the `bin` directory:
+##### To only generate documentation, while standing in the `bin` directory:
`dartdoc.py` generates all documentation and runs a local server with your html
pages.
@@ -21,6 +21,11 @@ html pages generated and no server).
`dartdoc.py -d -o package/to/document` ONLY generates documenation for the
specified package.
+##### To generate documentation and view it through the webpage:
+- Install [Google App Engine SDK for Python][GAE] (one time setup) and agree to
+ add symlinks so that dev\_appserver.py can be found on your PATH.
+- Run `dartdoc.py`.
+
### Generating files & uploading to Cloud Storage
The viewer uses YAML files generated by the docgen package as the data
@@ -59,7 +64,7 @@ for the outputted documentation.
###### Output directory
Documented libraries will be located at bin/docs in either YAML or JSON format
-depending on options specified. There will also be a library_list.json,
+depending on options specified. There will also be a library\_list.json,
containing a list of all the libraries inside the docs folder.
To get more information on how to use the outputted documentation with
« no previous file with comments | « no previous file | pkg/docgen/bin/dartdoc.py » ('j') | pkg/docgen/lib/docgen.dart » ('J')

Powered by Google App Engine
This is Rietveld 408576698