{"action":"created","issue":{"url":"https://api.github.com/repos/Workiva/dart_dev/issues/58","labels_url":"https://api.github.com/repos/Workiva/dart_dev/issues/58/labels{/name}","comments_url":"https://api.github.com/repos/Workiva/dart_dev/issues/58/comments","events_url":"https://api.github.com/repos/Workiva/dart_dev/issues/58/events","html_url":"https://github.com/Workiva/dart_dev/pull/58","id":103781323,"number":58,"title":"New Task: documentation generation via dartdoc.","user":{"login":"evanweible-wf","id":1738457,"avatar_url":"https://avatars.githubusercontent.com/u/1738457?v=3","gravatar_id":"","url":"https://api.github.com/users/evanweible-wf","html_url":"https://github.com/evanweible-wf","followers_url":"https://api.github.com/users/evanweible-wf/followers","following_url":"https://api.github.com/users/evanweible-wf/following{/other_user}","gists_url":"https://api.github.com/users/evanweible-wf/gists{/gist_id}","starred_url":"https://api.github.com/users/evanweible-wf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/evanweible-wf/subscriptions","organizations_url":"https://api.github.com/users/evanweible-wf/orgs","repos_url":"https://api.github.com/users/evanweible-wf/repos","events_url":"https://api.github.com/users/evanweible-wf/events{/privacy}","received_events_url":"https://api.github.com/users/evanweible-wf/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-08-28T19:30:58Z","updated_at":"2015-08-28T19:39:23Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/Workiva/dart_dev/pulls/58","html_url":"https://github.com/Workiva/dart_dev/pull/58","diff_url":"https://github.com/Workiva/dart_dev/pull/58.diff","patch_url":"https://github.com/Workiva/dart_dev/pull/58.patch"},"body":"## Issue\r\n#26 To round out the suite of tasks available, documentation generation should be included.\r\n\r\n## Changes\r\n**Source:**\r\n- Add a **docs** task that uses [dartdoc](https://github.com/dart-lang/dartdoc) to generate documentation\r\n- The defaults for documentation generation should be fairly standard, so for now, there are no configuration options\r\n- The CLI has an `--open` flag that defaults to true but can be negated. This flag controls whether or not the generated docs should be opened automatically.\r\n\r\n**Tests:**\r\n- Two integration tests added for the docs task.\r\n\r\n## Areas of Regression\r\n- n/a\r\n\r\n## Testing\r\n- Verify that the docs task successfully generates and opens documentation\r\n  - `ddev docs`\r\n  - `doc/api/` created\r\n  - `doc/api/index.html` opened automatically in browser\r\n- Verify that the docs are not opened automatically when `--no-open` is set\r\n  - `ddev docs --no-open`\r\n  - `doc/api/` created\r\n  - `doc/api/index.html` not opened\r\n- Verify that the task fails with explanation when the `dartdoc` package is not an immediate dependency\r\n  - remove `dartdoc` from pubspec.yaml\r\n  - `ddev docs`\r\n  - verify failure with explanation\r\n\r\n## Code Review\r\n@trentgrover-wf\r\n@maxwellpeterson-wf \r\n@dustinlessard-wf\r\n@jayudey-wf"},"comment":{"url":"https://api.github.com/repos/Workiva/dart_dev/issues/comments/135869052","html_url":"https://github.com/Workiva/dart_dev/pull/58#issuecomment-135869052","issue_url":"https://api.github.com/repos/Workiva/dart_dev/issues/58","id":135869052,"user":{"login":"evanweible-wf","id":1738457,"avatar_url":"https://avatars.githubusercontent.com/u/1738457?v=3","gravatar_id":"","url":"https://api.github.com/users/evanweible-wf","html_url":"https://github.com/evanweible-wf","followers_url":"https://api.github.com/users/evanweible-wf/followers","following_url":"https://api.github.com/users/evanweible-wf/following{/other_user}","gists_url":"https://api.github.com/users/evanweible-wf/gists{/gist_id}","starred_url":"https://api.github.com/users/evanweible-wf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/evanweible-wf/subscriptions","organizations_url":"https://api.github.com/users/evanweible-wf/orgs","repos_url":"https://api.github.com/users/evanweible-wf/repos","events_url":"https://api.github.com/users/evanweible-wf/events{/privacy}","received_events_url":"https://api.github.com/users/evanweible-wf/received_events","type":"User","site_admin":false},"created_at":"2015-08-28T19:39:23Z","updated_at":"2015-08-28T19:39:23Z","body":"If you're curious, here's what some docs generated by dartdoc look like now:\r\n\r\n<img width=\"866\" alt=\"screen shot 2015-08-28 at 2 37 37 pm\" src=\"https://cloud.githubusercontent.com/assets/1738457/9555401/6e703ab6-4d92-11e5-86bf-58d126c18886.png\">\r\n\r\nDefinitely a big improvement over the old docs. Also, this is only using dartdoc v0.4.0, but they're about to cut 0.6.2. The versions beyond 0.4.0 require dart 1.12 though."}}