{"action":"created","issue":{"url":"https://api.github.com/repos/JuliaLang/julia/issues/13790","repository_url":"https://api.github.com/repos/JuliaLang/julia","labels_url":"https://api.github.com/repos/JuliaLang/julia/issues/13790/labels{/name}","comments_url":"https://api.github.com/repos/JuliaLang/julia/issues/13790/comments","events_url":"https://api.github.com/repos/JuliaLang/julia/issues/13790/events","html_url":"https://github.com/JuliaLang/julia/issues/13790","id":113616869,"number":13790,"title":"Generate package documentation from docstrings","user":{"login":"quinnj","id":2896623,"avatar_url":"https://avatars.githubusercontent.com/u/2896623?v=3","gravatar_id":"","url":"https://api.github.com/users/quinnj","html_url":"https://github.com/quinnj","followers_url":"https://api.github.com/users/quinnj/followers","following_url":"https://api.github.com/users/quinnj/following{/other_user}","gists_url":"https://api.github.com/users/quinnj/gists{/gist_id}","starred_url":"https://api.github.com/users/quinnj/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/quinnj/subscriptions","organizations_url":"https://api.github.com/users/quinnj/orgs","repos_url":"https://api.github.com/users/quinnj/repos","events_url":"https://api.github.com/users/quinnj/events{/privacy}","received_events_url":"https://api.github.com/users/quinnj/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/JuliaLang/julia/labels/docsystem","name":"docsystem","color":"d4c5f9"},{"url":"https://api.github.com/repos/JuliaLang/julia/labels/packages","name":"packages","color":"02e10c"},{"url":"https://api.github.com/repos/JuliaLang/julia/labels/up%20for%20grabs","name":"up for grabs","color":"0b02e1"}],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":8,"created_at":"2015-10-27T15:53:20Z","updated_at":"2016-06-18T07:07:55Z","closed_at":"2016-06-18T07:07:55Z","body":"Having recently gone through the updating of several packages for 0.4 and trying out the new doc system, I first have to say, I love it! Much kudos to everyone who put in so much effort to build and make the transition.\r\n\r\nAs an extension to the wonderful new functionality, I find myself wanting to document the daylight out of my packages, but then find myself in an awkward position when I go to write my package's `README`. Do I duplicate everything? (tedious) Do I just point users to the help system? (not ideal since it's hard to quickly skim over an entire package's contents).\r\n\r\nI find myself wishing there was a quick script I could call on my package that would auto-generate a README from the combined docstrings in my package.\r\n\r\nI think this would be a great little piece of functionality that would probably be pretty approachable for anyone interested in giving it a go.\r\n\r\nI file the issue here, mainly because I'm not exactly sure where this would live. On the one hand, this could obviously go in a package by itself that package developers would then simply install and use. On the other hand, I could see this being something we include with our batteries for new bare packages, a single `generate_docs.jl` script that we maybe build into the package manager itself via `Pkg.docs(pkg)` or something like that. Happy to discuss more and get more concrete, but wanted to get the ball running for now."},"comment":{"url":"https://api.github.com/repos/JuliaLang/julia/issues/comments/226926509","html_url":"https://github.com/JuliaLang/julia/issues/13790#issuecomment-226926509","issue_url":"https://api.github.com/repos/JuliaLang/julia/issues/13790","id":226926509,"user":{"login":"MichaelHatherly","id":6144086,"avatar_url":"https://avatars.githubusercontent.com/u/6144086?v=3","gravatar_id":"","url":"https://api.github.com/users/MichaelHatherly","html_url":"https://github.com/MichaelHatherly","followers_url":"https://api.github.com/users/MichaelHatherly/followers","following_url":"https://api.github.com/users/MichaelHatherly/following{/other_user}","gists_url":"https://api.github.com/users/MichaelHatherly/gists{/gist_id}","starred_url":"https://api.github.com/users/MichaelHatherly/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/MichaelHatherly/subscriptions","organizations_url":"https://api.github.com/users/MichaelHatherly/orgs","repos_url":"https://api.github.com/users/MichaelHatherly/repos","events_url":"https://api.github.com/users/MichaelHatherly/events{/privacy}","received_events_url":"https://api.github.com/users/MichaelHatherly/received_events","type":"User","site_admin":false},"created_at":"2016-06-18T07:07:55Z","updated_at":"2016-06-18T07:07:55Z","body":"Closed by https://github.com/JuliaLang/METADATA.jl/pull/5396."}}
{"actor":{"display_login":"MichaelHatherly"}}