{"action":"created","comment":{"url":"https://api.github.com/repos/bazelbuild/skydoc/pulls/comments/220274700","pull_request_review_id":158643818,"id":220274700,"node_id":"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDIyMDI3NDcwMA==","diff_hunk":"@@ -0,0 +1,169 @@\n+---\n+layout: default\n+title: Generating Documentation\n+---\n+\n+<nav class=\"toc\">\n+  <h2>Contents</h2>\n+  <ul>\n+    <li><a href=\"#single-file\">Single File</a></li>\n+    <li><a href=\"#files-with-deps\">Files with Dependencies</a></li>\n+    <li><a href=\"#multiple-files\">Multiple Files</a></li>\n+  </ul>\n+</nav>\n+\n+The following are some examples of how to use Stardoc.\n+\n+<a name=\"single-file\"></a>\n+## Single File\n+\n+Suppose you have a project containing Stardoc rules you want to document:\n+\n+```\n+[workspace]/\n+    WORKSPACE\n+    checkstyle/\n+        BUILD\n+        checkstyle.bzl\n+```\n+\n+To generate documentation for the rules in `checkstyle.bzl`, add the\n+following target to `rules/BUILD`:\n+\n+```python\n+load(\"@io_bazel_skydoc//skylark:stardoc.bzl\", \"stardoc\")\n+\n+stardoc(\n+    name = \"checkstyle-docs\",\n+    input = \"checkstyle.bzl\",\n+    out = \"checkstyle_doc.md\",\n+)\n+```\n+\n+Running `bazel build //checkstyle:checkstyle-docs` will generate a markdown file\n+containing documentation for all Starlark rules defined in `checkstyle.bzl`.\n+\n+To generate a subset of rules defined in `checkstyle.bzl`, you may specify which\n+rule names you specifically want documentation for using the `symbol_names` attribute\n+of the `stardoc` rule. If `symbol_names` is specified, only rules matching a name\n+in `symbol_names` will be documented:","path":"site/docs/generating_stardoc.md","position":49,"original_position":49,"commit_id":"7169a1471f952cf2ef3dacbc71677f2acc9f602d","original_commit_id":"7169a1471f952cf2ef3dacbc71677f2acc9f602d","user":{"login":"laurentlb","id":485572,"node_id":"MDQ6VXNlcjQ4NTU3Mg==","avatar_url":"https://avatars2.githubusercontent.com/u/485572?v=4","gravatar_id":"","url":"https://api.github.com/users/laurentlb","html_url":"https://github.com/laurentlb","followers_url":"https://api.github.com/users/laurentlb/followers","following_url":"https://api.github.com/users/laurentlb/following{/other_user}","gists_url":"https://api.github.com/users/laurentlb/gists{/gist_id}","starred_url":"https://api.github.com/users/laurentlb/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/laurentlb/subscriptions","organizations_url":"https://api.github.com/users/laurentlb/orgs","repos_url":"https://api.github.com/users/laurentlb/repos","events_url":"https://api.github.com/users/laurentlb/events{/privacy}","received_events_url":"https://api.github.com/users/laurentlb/received_events","type":"User","site_admin":false},"body":"Do we have a use-case for `symbol_names`?","created_at":"2018-09-25T17:00:36Z","updated_at":"2018-09-25T17:00:54Z","html_url":"https://github.com/bazelbuild/skydoc/pull/107#discussion_r220274700","pull_request_url":"https://api.github.com/repos/bazelbuild/skydoc/pulls/107","author_association":"COLLABORATOR","_links":{"self":{"href":"https://api.github.com/repos/bazelbuild/skydoc/pulls/comments/220274700"},"html":{"href":"https://github.com/bazelbuild/skydoc/pull/107#discussion_r220274700"},"pull_request":{"href":"https://api.github.com/repos/bazelbuild/skydoc/pulls/107"}}},"pull_request":{"url":"https://api.github.com/repos/bazelbuild/skydoc/pulls/107","id":215702186,"node_id":"MDExOlB1bGxSZXF1ZXN0MjE1NzAyMTg2","html_url":"https://github.com/bazelbuild/skydoc/pull/107","diff_url":"https://github.com/bazelbuild/skydoc/pull/107.diff","patch_url":"https://github.com/bazelbuild/skydoc/pull/107.patch","issue_url":"https://api.github.com/repos/bazelbuild/skydoc/issues/107","number":107,"state":"open","locked":false,"title":"Document Stardoc on the Skydoc landing page","user":{"login":"c-parsons","id":13687552,"node_id":"MDQ6VXNlcjEzNjg3NTUy","avatar_url":"https://avatars0.githubusercontent.com/u/13687552?v=4","gravatar_id":"","url":"https://api.github.com/users/c-parsons","html_url":"https://github.com/c-parsons","followers_url":"https://api.github.com/users/c-parsons/followers","following_url":"https://api.github.com/users/c-parsons/following{/other_user}","gists_url":"https://api.github.com/users/c-parsons/gists{/gist_id}","starred_url":"https://api.github.com/users/c-parsons/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/c-parsons/subscriptions","organizations_url":"https://api.github.com/users/c-parsons/orgs","repos_url":"https://api.github.com/users/c-parsons/repos","events_url":"https://api.github.com/users/c-parsons/events{/privacy}","received_events_url":"https://api.github.com/users/c-parsons/received_events","type":"User","site_admin":false},"body":"","created_at":"2018-09-14T20:26:04Z","updated_at":"2018-09-25T17:00:53Z","closed_at":null,"merged_at":null,"merge_commit_sha":"96f780934485a83bc181fd7f60baad56b85e9ff8","assignee":null,"assignees":[],"requested_reviewers":[{"login":"davidzchen","id":5283042,"node_id":"MDQ6VXNlcjUyODMwNDI=","avatar_url":"https://avatars1.githubusercontent.com/u/5283042?v=4","gravatar_id":"","url":"https://api.github.com/users/davidzchen","html_url":"https://github.com/davidzchen","followers_url":"https://api.github.com/users/davidzchen/followers","following_url":"https://api.github.com/users/davidzchen/following{/other_user}","gists_url":"https://api.github.com/users/davidzchen/gists{/gist_id}","starred_url":"https://api.github.com/users/davidzchen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/davidzchen/subscriptions","organizations_url":"https://api.github.com/users/davidzchen/orgs","repos_url":"https://api.github.com/users/davidzchen/repos","events_url":"https://api.github.com/users/davidzchen/events{/privacy}","received_events_url":"https://api.github.com/users/davidzchen/received_events","type":"User","site_admin":false},{"login":"spomorski","id":28788978,"node_id":"MDQ6VXNlcjI4Nzg4OTc4","avatar_url":"https://avatars0.githubusercontent.com/u/28788978?v=4","gravatar_id":"","url":"https://api.github.com/users/spomorski","html_url":"https://github.com/spomorski","followers_url":"https://api.github.com/users/spomorski/followers","following_url":"https://api.github.com/users/spomorski/following{/other_user}","gists_url":"https://api.github.com/users/spomorski/gists{/gist_id}","starred_url":"https://api.github.com/users/spomorski/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/spomorski/subscriptions","organizations_url":"https://api.github.com/users/spomorski/orgs","repos_url":"https://api.github.com/users/spomorski/repos","events_url":"https://api.github.com/users/spomorski/events{/privacy}","received_events_url":"https://api.github.com/users/spomorski/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[{"id":350147962,"node_id":"MDU6TGFiZWwzNTAxNDc5NjI=","url":"https://api.github.com/repos/bazelbuild/skydoc/labels/cla:%20yes","name":"cla: yes","color":"0e8a16","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/bazelbuild/skydoc/pulls/107/commits","review_comments_url":"https://api.github.com/repos/bazelbuild/skydoc/pulls/107/comments","review_comment_url":"https://api.github.com/repos/bazelbuild/skydoc/pulls/comments{/number}","comments_url":"https://api.github.com/repos/bazelbuild/skydoc/issues/107/comments","statuses_url":"https://api.github.com/repos/bazelbuild/skydoc/statuses/7169a1471f952cf2ef3dacbc71677f2acc9f602d","head":{"label":"bazelbuild:stardoc-site-checkin","ref":"stardoc-site-checkin","sha":"7169a1471f952cf2ef3dacbc71677f2acc9f602d","user":{"login":"bazelbuild","id":11684617,"node_id":"MDEyOk9yZ2FuaXphdGlvbjExNjg0NjE3","avatar_url":"https://avatars1.githubusercontent.com/u/11684617?v=4","gravatar_id":"","url":"https://api.github.com/users/bazelbuild","html_url":"https://github.com/bazelbuild","followers_url":"https://api.github.com/users/bazelbuild/followers","following_url":"https://api.github.com/users/bazelbuild/following{/other_user}","gists_url":"https://api.github.com/users/bazelbuild/gists{/gist_id}","starred_url":"https://api.github.com/users/bazelbuild/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bazelbuild/subscriptions","organizations_url":"https://api.github.com/users/bazelbuild/orgs","repos_url":"https://api.github.com/users/bazelbuild/repos","events_url":"https://api.github.com/users/bazelbuild/events{/privacy}","received_events_url":"https://api.github.com/users/bazelbuild/received_events","type":"Organization","site_admin":false},"repo":{"id":55097513,"node_id":"MDEwOlJlcG9zaXRvcnk1NTA5NzUxMw==","name":"skydoc","full_name":"bazelbuild/skydoc","private":false,"owner":{"login":"bazelbuild","id":11684617,"node_id":"MDEyOk9yZ2FuaXphdGlvbjExNjg0NjE3","avatar_url":"https://avatars1.githubusercontent.com/u/11684617?v=4","gravatar_id":"","url":"https://api.github.com/users/bazelbuild","html_url":"https://github.com/bazelbuild","followers_url":"https://api.github.com/users/bazelbuild/followers","following_url":"https://api.github.com/users/bazelbuild/following{/other_user}","gists_url":"https://api.github.com/users/bazelbuild/gists{/gist_id}","starred_url":"https://api.github.com/users/bazelbuild/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bazelbuild/subscriptions","organizations_url":"https://api.github.com/users/bazelbuild/orgs","repos_url":"https://api.github.com/users/bazelbuild/repos","events_url":"https://api.github.com/users/bazelbuild/events{/privacy}","received_events_url":"https://api.github.com/users/bazelbuild/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/bazelbuild/skydoc","description":"Documentation generator for Skylark","fork":false,"url":"https://api.github.com/repos/bazelbuild/skydoc","forks_url":"https://api.github.com/repos/bazelbuild/skydoc/forks","keys_url":"https://api.github.com/repos/bazelbuild/skydoc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/bazelbuild/skydoc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/bazelbuild/skydoc/teams","hooks_url":"https://api.github.com/repos/bazelbuild/skydoc/hooks","issue_events_url":"https://api.github.com/repos/bazelbuild/skydoc/issues/events{/number}","events_url":"https://api.github.com/repos/bazelbuild/skydoc/events","assignees_url":"https://api.github.com/repos/bazelbuild/skydoc/assignees{/user}","branches_url":"https://api.github.com/repos/bazelbuild/skydoc/branches{/branch}","tags_url":"https://api.github.com/repos/bazelbuild/skydoc/tags","blobs_url":"https://api.github.com/repos/bazelbuild/skydoc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/bazelbuild/skydoc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/bazelbuild/skydoc/git/refs{/sha}","trees_url":"https://api.github.com/repos/bazelbuild/skydoc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/bazelbuild/skydoc/statuses/{sha}","languages_url":"https://api.github.com/repos/bazelbuild/skydoc/languages","stargazers_url":"https://api.github.com/repos/bazelbuild/skydoc/stargazers","contributors_url":"https://api.github.com/repos/bazelbuild/skydoc/contributors","subscribers_url":"https://api.github.com/repos/bazelbuild/skydoc/subscribers","subscription_url":"https://api.github.com/repos/bazelbuild/skydoc/subscription","commits_url":"https://api.github.com/repos/bazelbuild/skydoc/commits{/sha}","git_commits_url":"https://api.github.com/repos/bazelbuild/skydoc/git/commits{/sha}","comments_url":"https://api.github.com/repos/bazelbuild/skydoc/comments{/number}","issue_comment_url":"https://api.github.com/repos/bazelbuild/skydoc/issues/comments{/number}","contents_url":"https://api.github.com/repos/bazelbuild/skydoc/contents/{+path}","compare_url":"https://api.github.com/repos/bazelbuild/skydoc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/bazelbuild/skydoc/merges","archive_url":"https://api.github.com/repos/bazelbuild/skydoc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/bazelbuild/skydoc/downloads","issues_url":"https://api.github.com/repos/bazelbuild/skydoc/issues{/number}","pulls_url":"https://api.github.com/repos/bazelbuild/skydoc/pulls{/number}","milestones_url":"https://api.github.com/repos/bazelbuild/skydoc/milestones{/number}","notifications_url":"https://api.github.com/repos/bazelbuild/skydoc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/bazelbuild/skydoc/labels{/name}","releases_url":"https://api.github.com/repos/bazelbuild/skydoc/releases{/id}","deployments_url":"https://api.github.com/repos/bazelbuild/skydoc/deployments","created_at":"2016-03-30T21:00:57Z","updated_at":"2018-09-24T14:47:28Z","pushed_at":"2018-09-24T14:47:26Z","git_url":"git://github.com/bazelbuild/skydoc.git","ssh_url":"git@github.com:bazelbuild/skydoc.git","clone_url":"https://github.com/bazelbuild/skydoc.git","svn_url":"https://github.com/bazelbuild/skydoc","homepage":"https://skydoc.bazel.build/","size":318,"stargazers_count":26,"watchers_count":26,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":33,"mirror_url":null,"archived":false,"open_issues_count":26,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":33,"open_issues":26,"watchers":26,"default_branch":"master"}},"base":{"label":"bazelbuild:master","ref":"master","sha":"d34c44c3f4102eb94beaf2636c6cf532f0ec1ee8","user":{"login":"bazelbuild","id":11684617,"node_id":"MDEyOk9yZ2FuaXphdGlvbjExNjg0NjE3","avatar_url":"https://avatars1.githubusercontent.com/u/11684617?v=4","gravatar_id":"","url":"https://api.github.com/users/bazelbuild","html_url":"https://github.com/bazelbuild","followers_url":"https://api.github.com/users/bazelbuild/followers","following_url":"https://api.github.com/users/bazelbuild/following{/other_user}","gists_url":"https://api.github.com/users/bazelbuild/gists{/gist_id}","starred_url":"https://api.github.com/users/bazelbuild/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bazelbuild/subscriptions","organizations_url":"https://api.github.com/users/bazelbuild/orgs","repos_url":"https://api.github.com/users/bazelbuild/repos","events_url":"https://api.github.com/users/bazelbuild/events{/privacy}","received_events_url":"https://api.github.com/users/bazelbuild/received_events","type":"Organization","site_admin":false},"repo":{"id":55097513,"node_id":"MDEwOlJlcG9zaXRvcnk1NTA5NzUxMw==","name":"skydoc","full_name":"bazelbuild/skydoc","private":false,"owner":{"login":"bazelbuild","id":11684617,"node_id":"MDEyOk9yZ2FuaXphdGlvbjExNjg0NjE3","avatar_url":"https://avatars1.githubusercontent.com/u/11684617?v=4","gravatar_id":"","url":"https://api.github.com/users/bazelbuild","html_url":"https://github.com/bazelbuild","followers_url":"https://api.github.com/users/bazelbuild/followers","following_url":"https://api.github.com/users/bazelbuild/following{/other_user}","gists_url":"https://api.github.com/users/bazelbuild/gists{/gist_id}","starred_url":"https://api.github.com/users/bazelbuild/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bazelbuild/subscriptions","organizations_url":"https://api.github.com/users/bazelbuild/orgs","repos_url":"https://api.github.com/users/bazelbuild/repos","events_url":"https://api.github.com/users/bazelbuild/events{/privacy}","received_events_url":"https://api.github.com/users/bazelbuild/received_events","type":"Organization","site_admin":false},"html_url":"https://github.com/bazelbuild/skydoc","description":"Documentation generator for Skylark","fork":false,"url":"https://api.github.com/repos/bazelbuild/skydoc","forks_url":"https://api.github.com/repos/bazelbuild/skydoc/forks","keys_url":"https://api.github.com/repos/bazelbuild/skydoc/keys{/key_id}","collaborators_url":"https://api.github.com/repos/bazelbuild/skydoc/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/bazelbuild/skydoc/teams","hooks_url":"https://api.github.com/repos/bazelbuild/skydoc/hooks","issue_events_url":"https://api.github.com/repos/bazelbuild/skydoc/issues/events{/number}","events_url":"https://api.github.com/repos/bazelbuild/skydoc/events","assignees_url":"https://api.github.com/repos/bazelbuild/skydoc/assignees{/user}","branches_url":"https://api.github.com/repos/bazelbuild/skydoc/branches{/branch}","tags_url":"https://api.github.com/repos/bazelbuild/skydoc/tags","blobs_url":"https://api.github.com/repos/bazelbuild/skydoc/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/bazelbuild/skydoc/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/bazelbuild/skydoc/git/refs{/sha}","trees_url":"https://api.github.com/repos/bazelbuild/skydoc/git/trees{/sha}","statuses_url":"https://api.github.com/repos/bazelbuild/skydoc/statuses/{sha}","languages_url":"https://api.github.com/repos/bazelbuild/skydoc/languages","stargazers_url":"https://api.github.com/repos/bazelbuild/skydoc/stargazers","contributors_url":"https://api.github.com/repos/bazelbuild/skydoc/contributors","subscribers_url":"https://api.github.com/repos/bazelbuild/skydoc/subscribers","subscription_url":"https://api.github.com/repos/bazelbuild/skydoc/subscription","commits_url":"https://api.github.com/repos/bazelbuild/skydoc/commits{/sha}","git_commits_url":"https://api.github.com/repos/bazelbuild/skydoc/git/commits{/sha}","comments_url":"https://api.github.com/repos/bazelbuild/skydoc/comments{/number}","issue_comment_url":"https://api.github.com/repos/bazelbuild/skydoc/issues/comments{/number}","contents_url":"https://api.github.com/repos/bazelbuild/skydoc/contents/{+path}","compare_url":"https://api.github.com/repos/bazelbuild/skydoc/compare/{base}...{head}","merges_url":"https://api.github.com/repos/bazelbuild/skydoc/merges","archive_url":"https://api.github.com/repos/bazelbuild/skydoc/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/bazelbuild/skydoc/downloads","issues_url":"https://api.github.com/repos/bazelbuild/skydoc/issues{/number}","pulls_url":"https://api.github.com/repos/bazelbuild/skydoc/pulls{/number}","milestones_url":"https://api.github.com/repos/bazelbuild/skydoc/milestones{/number}","notifications_url":"https://api.github.com/repos/bazelbuild/skydoc/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/bazelbuild/skydoc/labels{/name}","releases_url":"https://api.github.com/repos/bazelbuild/skydoc/releases{/id}","deployments_url":"https://api.github.com/repos/bazelbuild/skydoc/deployments","created_at":"2016-03-30T21:00:57Z","updated_at":"2018-09-24T14:47:28Z","pushed_at":"2018-09-24T14:47:26Z","git_url":"git://github.com/bazelbuild/skydoc.git","ssh_url":"git@github.com:bazelbuild/skydoc.git","clone_url":"https://github.com/bazelbuild/skydoc.git","svn_url":"https://github.com/bazelbuild/skydoc","homepage":"https://skydoc.bazel.build/","size":318,"stargazers_count":26,"watchers_count":26,"language":"Python","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":33,"mirror_url":null,"archived":false,"open_issues_count":26,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0","node_id":"MDc6TGljZW5zZTI="},"forks":33,"open_issues":26,"watchers":26,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/bazelbuild/skydoc/pulls/107"},"html":{"href":"https://github.com/bazelbuild/skydoc/pull/107"},"issue":{"href":"https://api.github.com/repos/bazelbuild/skydoc/issues/107"},"comments":{"href":"https://api.github.com/repos/bazelbuild/skydoc/issues/107/comments"},"review_comments":{"href":"https://api.github.com/repos/bazelbuild/skydoc/pulls/107/comments"},"review_comment":{"href":"https://api.github.com/repos/bazelbuild/skydoc/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/bazelbuild/skydoc/pulls/107/commits"},"statuses":{"href":"https://api.github.com/repos/bazelbuild/skydoc/statuses/7169a1471f952cf2ef3dacbc71677f2acc9f602d"}},"author_association":"COLLABORATOR"}}
{"actor":{"display_login":"laurentlb"}}