{"action":"created","issue":{"url":"https://api.github.com/repos/rtfd/sphinx-autoapi/issues/5","repository_url":"https://api.github.com/repos/rtfd/sphinx-autoapi","labels_url":"https://api.github.com/repos/rtfd/sphinx-autoapi/issues/5/labels{/name}","comments_url":"https://api.github.com/repos/rtfd/sphinx-autoapi/issues/5/comments","events_url":"https://api.github.com/repos/rtfd/sphinx-autoapi/issues/5/events","html_url":"https://github.com/rtfd/sphinx-autoapi/issues/5","id":84198698,"number":5,"title":"Add POD parsing support to autoapi","user":{"login":"agjohnson","id":1140183,"avatar_url":"https://avatars.githubusercontent.com/u/1140183?v=3","gravatar_id":"","url":"https://api.github.com/users/agjohnson","html_url":"https://github.com/agjohnson","followers_url":"https://api.github.com/users/agjohnson/followers","following_url":"https://api.github.com/users/agjohnson/following{/other_user}","gists_url":"https://api.github.com/users/agjohnson/gists{/gist_id}","starred_url":"https://api.github.com/users/agjohnson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/agjohnson/subscriptions","organizations_url":"https://api.github.com/users/agjohnson/orgs","repos_url":"https://api.github.com/users/agjohnson/repos","events_url":"https://api.github.com/users/agjohnson/events{/privacy}","received_events_url":"https://api.github.com/users/agjohnson/received_events","type":"User","site_admin":false},"labels":[{"id":219649483,"url":"https://api.github.com/repos/rtfd/sphinx-autoapi/labels/Needed:%20feedback","name":"Needed: feedback","color":"454545","default":false}],"state":"open","locked":false,"assignee":{"login":"agjohnson","id":1140183,"avatar_url":"https://avatars.githubusercontent.com/u/1140183?v=3","gravatar_id":"","url":"https://api.github.com/users/agjohnson","html_url":"https://github.com/agjohnson","followers_url":"https://api.github.com/users/agjohnson/followers","following_url":"https://api.github.com/users/agjohnson/following{/other_user}","gists_url":"https://api.github.com/users/agjohnson/gists{/gist_id}","starred_url":"https://api.github.com/users/agjohnson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/agjohnson/subscriptions","organizations_url":"https://api.github.com/users/agjohnson/orgs","repos_url":"https://api.github.com/users/agjohnson/repos","events_url":"https://api.github.com/users/agjohnson/events{/privacy}","received_events_url":"https://api.github.com/users/agjohnson/received_events","type":"User","site_admin":false},"assignees":[{"login":"agjohnson","id":1140183,"avatar_url":"https://avatars.githubusercontent.com/u/1140183?v=3","gravatar_id":"","url":"https://api.github.com/users/agjohnson","html_url":"https://github.com/agjohnson","followers_url":"https://api.github.com/users/agjohnson/followers","following_url":"https://api.github.com/users/agjohnson/following{/other_user}","gists_url":"https://api.github.com/users/agjohnson/gists{/gist_id}","starred_url":"https://api.github.com/users/agjohnson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/agjohnson/subscriptions","organizations_url":"https://api.github.com/users/agjohnson/orgs","repos_url":"https://api.github.com/users/agjohnson/repos","events_url":"https://api.github.com/users/agjohnson/events{/privacy}","received_events_url":"https://api.github.com/users/agjohnson/received_events","type":"User","site_admin":false}],"milestone":null,"comments":1,"created_at":"2015-06-02T20:32:24Z","updated_at":"2017-02-07T15:02:52Z","closed_at":null,"body":"Moving discussion on rtfd/readthedocs.org#1319 here for the time being.\n\nI started tackling this problem a few months ago and have a working prototype. Putting this here for some feedback on supporting just pulling out POD blocks from source `pm` files.\n\nSo, parsing POD (or another markup lacking semantics for language constructs/etc) is useful for prose documentation, but without semantics for language constructs, these formats are only proxies to HTML and text output. At best, we could parse every heading for something that looks like a function/method/etc, but even then, good luck getting everyone to write in a systematic format.\n\nA solution to this is to use a markup with directives for adding semantic meaning to blocks: rST. rST is much more powerful, providing all of the structure for defining language constructs and linking them easily. This would be a breaking change to hosting on CPAN/MetaCPAN, but with a helper like a `Build.PL` trigger to compile POD on release, this could be likely easily be preserved.\n\nYour source would end up looking something like:\n\n``` perl\npackage Foo::Bar;\n\n=begin rst\n.. pl:package:: Foo::Bar\n\n.. pl:function:: foo(arg1, arg2, arg3)\n    :param arg1: First argument\n    :type arg1: str\n    :param arg2: Second argument, no type\n    :param arg3: Third argument\n    :type arg3: []\n\n    This is a function for doing foo\n=cut\nsub foo() {\n    ...\n}\n\n=pod\n.. pl:function:: bar(arg1)\n\n    Calls :pl:func:`foo` with :pl:data:`arg1`\n\n=end rst\nsub bar {\n    ...\n}\n1;\n```\n\nOpen to comments, input, and other crazy ideas here.\n"},"comment":{"url":"https://api.github.com/repos/rtfd/sphinx-autoapi/issues/comments/278025581","html_url":"https://github.com/rtfd/sphinx-autoapi/issues/5#issuecomment-278025581","issue_url":"https://api.github.com/repos/rtfd/sphinx-autoapi/issues/5","id":278025581,"user":{"login":"WildYorkies","id":1299322,"avatar_url":"https://avatars.githubusercontent.com/u/1299322?v=3","gravatar_id":"","url":"https://api.github.com/users/WildYorkies","html_url":"https://github.com/WildYorkies","followers_url":"https://api.github.com/users/WildYorkies/followers","following_url":"https://api.github.com/users/WildYorkies/following{/other_user}","gists_url":"https://api.github.com/users/WildYorkies/gists{/gist_id}","starred_url":"https://api.github.com/users/WildYorkies/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/WildYorkies/subscriptions","organizations_url":"https://api.github.com/users/WildYorkies/orgs","repos_url":"https://api.github.com/users/WildYorkies/repos","events_url":"https://api.github.com/users/WildYorkies/events{/privacy}","received_events_url":"https://api.github.com/users/WildYorkies/received_events","type":"User","site_admin":false},"created_at":"2017-02-07T15:02:52Z","updated_at":"2017-02-07T15:02:52Z","body":"@agjohnson I'm looking into hosting Perl6 documentation on a variety of other formats (like RTD). https://github.com/perl6/doc There's the repo for the current format that is used.\r\n\r\nDid you end up abandoning this effort altogether?"}}
{"actor":{"display_login":"WildYorkies"}}