{"action":"created","issue":{"url":"https://api.github.com/repos/CISecurity/OVALRepo/issues/16","labels_url":"https://api.github.com/repos/CISecurity/OVALRepo/issues/16/labels{/name}","comments_url":"https://api.github.com/repos/CISecurity/OVALRepo/issues/16/comments","events_url":"https://api.github.com/repos/CISecurity/OVALRepo/issues/16/events","html_url":"https://github.com/CISecurity/OVALRepo/issues/16","id":94313126,"number":16,"title":"API Documentation Generation","user":{"login":"GunnarEngelbach","id":13241056,"avatar_url":"https://avatars.githubusercontent.com/u/13241056?v=3","gravatar_id":"","url":"https://api.github.com/users/GunnarEngelbach","html_url":"https://github.com/GunnarEngelbach","followers_url":"https://api.github.com/users/GunnarEngelbach/followers","following_url":"https://api.github.com/users/GunnarEngelbach/following{/other_user}","gists_url":"https://api.github.com/users/GunnarEngelbach/gists{/gist_id}","starred_url":"https://api.github.com/users/GunnarEngelbach/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/GunnarEngelbach/subscriptions","organizations_url":"https://api.github.com/users/GunnarEngelbach/orgs","repos_url":"https://api.github.com/users/GunnarEngelbach/repos","events_url":"https://api.github.com/users/GunnarEngelbach/events{/privacy}","received_events_url":"https://api.github.com/users/GunnarEngelbach/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":3,"created_at":"2015-07-10T14:08:12Z","updated_at":"2015-07-10T15:40:22Z","closed_at":null,"body":"I thought it would be helpful to take advantage of the doc strings in the script files to generate API documentation, so I started looking into that.\r\n\r\nSimply using pydoc -w should suffice, but I tried that against the existing source and all files returned an error message about not having doc strings -- which, to my manual examination, they do, so this is likely user error.\r\n\r\nStill,  Sphinx (http://sphinx-doc.org/) comes highly recommended for this usage, but I have not yet taken the time to get that set up and working.\r\n\r\nDoes anybody else have opinions or suggestions?"},"comment":{"url":"https://api.github.com/repos/CISecurity/OVALRepo/issues/comments/120438806","html_url":"https://github.com/CISecurity/OVALRepo/issues/16#issuecomment-120438806","issue_url":"https://api.github.com/repos/CISecurity/OVALRepo/issues/16","id":120438806,"user":{"login":"DavidRies","id":728508,"avatar_url":"https://avatars.githubusercontent.com/u/728508?v=3","gravatar_id":"","url":"https://api.github.com/users/DavidRies","html_url":"https://github.com/DavidRies","followers_url":"https://api.github.com/users/DavidRies/followers","following_url":"https://api.github.com/users/DavidRies/following{/other_user}","gists_url":"https://api.github.com/users/DavidRies/gists{/gist_id}","starred_url":"https://api.github.com/users/DavidRies/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/DavidRies/subscriptions","organizations_url":"https://api.github.com/users/DavidRies/orgs","repos_url":"https://api.github.com/users/DavidRies/repos","events_url":"https://api.github.com/users/DavidRies/events{/privacy}","received_events_url":"https://api.github.com/users/DavidRies/received_events","type":"User","site_admin":false},"created_at":"2015-07-10T15:40:22Z","updated_at":"2015-07-10T15:40:22Z","body":"That makes sense! I would use it if you made it, :) but am ok without (at least for now… we’ll see how big this thing gets).\n\n> On Jul 10, 2015, at 10:28 AM, GunnarEngelbach <notifications@github.com> wrote:\n> \n> My initial thought was just to assist our own productivity. It's considerably easier to find an API using documentation than it is to search through source code. This would also assist maintainers who come after us.\n> \n> Secondarily it would be nice auto-generate nicely formatted documentation pages similar to a readme file, rather than having to make those separately. Plus that adds an slight air of professionalism to the project which might assist in public perception.\n> \n> I'm also experimenting with using the PyDev plugin for Eclipse for development. It purports to include code completion, so that could be even handier than referencing external documentation. I'll share impressions after I've spent more time with it. But with, realistically, only about two weeks to go, I'll probably fall back to vi pretty soon.\n> \n> Anyway, would anybody else benefit from having API documentation generated from the libraries and added to the repository? It's not worth the time if it's only me.\n> \n> —\n> Reply to this email directly or view it on GitHub <https://github.com/CISecurity/OVALRepo/issues/16#issuecomment-120436514>.\n> \n\n-David\n\n--\nDavid E. Ries\nPartner\nFarnam Hall Ventures \n\nfarnamhallventures.com <http://farnamhallventures.com/>\n"}}