pkg/docgen/README.md - Issue 56183003: Refactor scripts, so we have a single entrypoint, dartdoc.py, to generate docs.

Keyboard Shortcuts

	File
u :	up to issue
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line

	Issue
u :	up to list of issues
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue

Unified Diff: pkg/docgen/README.md

Issue 56183003: Refactor scripts, so we have a single entrypoint, dartdoc.py, to generate docs. (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

Index: pkg/docgen/README.md

diff --git a/pkg/docgen/README.md b/pkg/docgen/README.md

index 343d9c0937cfcadf4c6399a28c2e9cfecb14aa41..ff0fac70dbbf84391adad6c3d2c0d2334f3323f9 100644

--- a/pkg/docgen/README.md

+++ b/pkg/docgen/README.md

@@ -8,6 +8,19 @@ for all `.dart` file it finds as YAML or JSON files. This outputs information

about all classes, variables, functions, and methods defined in the library and

its imported libraries.

+### Quick Start: Common Commands

+While standing in the `bin` directory:

+`dartdoc.py` generates all documentation and runs a local server with your html

+pages.

+`dartdoc.py -d` ONLY generates documentation for the SDK and all packages (no

+html pages generated and no server).

+`dartdoc.py -d -o package/to/document` ONLY generates documenation for the

+specified package.

### Generating files & uploading to Cloud Storage

The viewer uses YAML files generated by the docgen package as the data

« no previous file with comments | « no previous file | pkg/docgen/bin/dartdoc.py » ('j') | pkg/docgen/bin/dartdoc.py » ('J')