{"action":"created","issue":{"url":"https://api.github.com/repos/almende/vis/issues/3497","repository_url":"https://api.github.com/repos/almende/vis","labels_url":"https://api.github.com/repos/almende/vis/issues/3497/labels{/name}","comments_url":"https://api.github.com/repos/almende/vis/issues/3497/comments","events_url":"https://api.github.com/repos/almende/vis/issues/3497/events","html_url":"https://github.com/almende/vis/pull/3497","id":261528941,"number":3497,"title":"Add template for document generation with 'jsdoc'.","user":{"login":"wimrijnders","id":769037,"avatar_url":"https://avatars1.githubusercontent.com/u/769037?v=4","gravatar_id":"","url":"https://api.github.com/users/wimrijnders","html_url":"https://github.com/wimrijnders","followers_url":"https://api.github.com/users/wimrijnders/followers","following_url":"https://api.github.com/users/wimrijnders/following{/other_user}","gists_url":"https://api.github.com/users/wimrijnders/gists{/gist_id}","starred_url":"https://api.github.com/users/wimrijnders/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/wimrijnders/subscriptions","organizations_url":"https://api.github.com/users/wimrijnders/orgs","repos_url":"https://api.github.com/users/wimrijnders/repos","events_url":"https://api.github.com/users/wimrijnders/events{/privacy}","received_events_url":"https://api.github.com/users/wimrijnders/received_events","type":"User","site_admin":false},"labels":[{"id":417544172,"url":"https://api.github.com/repos/almende/vis/labels/Docs","name":"Docs","color":"fef2c0","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":6,"created_at":"2017-09-29T04:28:34Z","updated_at":"2017-10-01T18:40:16Z","closed_at":null,"author_association":"CONTRIBUTOR","pull_request":{"url":"https://api.github.com/repos/almende/vis/pulls/3497","html_url":"https://github.com/almende/vis/pull/3497","diff_url":"https://github.com/almende/vis/pull/3497.diff","patch_url":"https://github.com/almende/vis/pull/3497.patch"},"body":"In essence, this PR defines the subdirectory `docs` as a `jsdoc` template.\r\n\r\n**Benefits:**\r\n- allows the usage of partials, in order to DRY common parts of the html files.\r\n- makes available the `jsdoc`-comments, for addition into the documentation.\r\n- enables extraction of data from the source code. For example, the list of edge endpoints `['arrow', 'bar', 'circle']` can now be extracted from the source and inserted into the documentation on generation.\r\n\r\n----\r\nIn this initial version, the only file that has been changed is `docs/data/dataset.html`. Here, partials have been added to illustrate how common page elements can be DRY'd.\r\n\r\nThe template has been set up in such a way, that resource files will be copied and that html files can pass through unchanged if no special template tags (`<?js...?>`) are used. This allows for a gradual transition of the html files to templates.\r\n\r\nA `README.md` has been added to subdirectory `docs`, with notes on how to use the `jsdoc`-generated comment data.\r\n\r\n----\r\n**Usage:**  `gulp docs`\r\n\r\n- The result files are placed in subdirectory `gen/docs/`.\r\n\r\n**NOTE:** The release procedure will have to be adjusted by adding this gulp command.\r\nThe docs-files will then have to be taken from `gen/docs`.\r\n"},"comment":{"url":"https://api.github.com/repos/almende/vis/issues/comments/333397172","html_url":"https://github.com/almende/vis/pull/3497#issuecomment-333397172","issue_url":"https://api.github.com/repos/almende/vis/issues/3497","id":333397172,"user":{"login":"mbroad","id":2454667,"avatar_url":"https://avatars2.githubusercontent.com/u/2454667?v=4","gravatar_id":"","url":"https://api.github.com/users/mbroad","html_url":"https://github.com/mbroad","followers_url":"https://api.github.com/users/mbroad/followers","following_url":"https://api.github.com/users/mbroad/following{/other_user}","gists_url":"https://api.github.com/users/mbroad/gists{/gist_id}","starred_url":"https://api.github.com/users/mbroad/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mbroad/subscriptions","organizations_url":"https://api.github.com/users/mbroad/orgs","repos_url":"https://api.github.com/users/mbroad/repos","events_url":"https://api.github.com/users/mbroad/events{/privacy}","received_events_url":"https://api.github.com/users/mbroad/received_events","type":"User","site_admin":false},"created_at":"2017-10-01T18:40:16Z","updated_at":"2017-10-01T18:40:16Z","author_association":"NONE","body":"Excellent!"}}
{"actor":{"display_login":"mbroad"}}