{"action":"created","issue":{"url":"https://api.github.com/repos/cliffordwolf/yosys/issues/439","repository_url":"https://api.github.com/repos/cliffordwolf/yosys","labels_url":"https://api.github.com/repos/cliffordwolf/yosys/issues/439/labels{/name}","comments_url":"https://api.github.com/repos/cliffordwolf/yosys/issues/439/comments","events_url":"https://api.github.com/repos/cliffordwolf/yosys/issues/439/events","html_url":"https://github.com/cliffordwolf/yosys/issues/439","id":267226562,"number":439,"title":"Auto-generate documentation","user":{"login":"mithro","id":21212,"avatar_url":"https://avatars2.githubusercontent.com/u/21212?v=4","gravatar_id":"","url":"https://api.github.com/users/mithro","html_url":"https://github.com/mithro","followers_url":"https://api.github.com/users/mithro/followers","following_url":"https://api.github.com/users/mithro/following{/other_user}","gists_url":"https://api.github.com/users/mithro/gists{/gist_id}","starred_url":"https://api.github.com/users/mithro/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/mithro/subscriptions","organizations_url":"https://api.github.com/users/mithro/orgs","repos_url":"https://api.github.com/users/mithro/repos","events_url":"https://api.github.com/users/mithro/events{/privacy}","received_events_url":"https://api.github.com/users/mithro/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-10-20T16:09:44Z","updated_at":"2017-10-20T16:12:15Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"It would be good if there was some auto-generated documentation for Yosys like [these ones for VTR](http://docs.verilogtorouting.org/en/latest/vtr/).\r\n\r\nMy suggestion is to make docs generated with [Sphinx](http://www.sphinx-doc.org) and [probably Breathe](http://breathe.readthedocs.io/en/latest/). This works by having standard [Doxygen style comments](http://www.stack.nl/~dimitri/doxygen/manual/docblocks.html) in your C++ code.\r\n\r\nIf this option is chosen, then the documentation can be auto generated on [readthedocs](http://readthedocs.org/).\r\n\r\nThoughts?"},"comment":{"url":"https://api.github.com/repos/cliffordwolf/yosys/issues/comments/338251943","html_url":"https://github.com/cliffordwolf/yosys/issues/439#issuecomment-338251943","issue_url":"https://api.github.com/repos/cliffordwolf/yosys/issues/439","id":338251943,"user":{"login":"cliffordwolf","id":619764,"avatar_url":"https://avatars3.githubusercontent.com/u/619764?v=4","gravatar_id":"","url":"https://api.github.com/users/cliffordwolf","html_url":"https://github.com/cliffordwolf","followers_url":"https://api.github.com/users/cliffordwolf/followers","following_url":"https://api.github.com/users/cliffordwolf/following{/other_user}","gists_url":"https://api.github.com/users/cliffordwolf/gists{/gist_id}","starred_url":"https://api.github.com/users/cliffordwolf/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/cliffordwolf/subscriptions","organizations_url":"https://api.github.com/users/cliffordwolf/orgs","repos_url":"https://api.github.com/users/cliffordwolf/repos","events_url":"https://api.github.com/users/cliffordwolf/events{/privacy}","received_events_url":"https://api.github.com/users/cliffordwolf/received_events","type":"User","site_admin":false},"created_at":"2017-10-20T16:12:15Z","updated_at":"2017-10-20T16:12:15Z","author_association":"OWNER","body":"About 80 pages of the manual are auto-generated documentation (Appendix C), so is the command reference on the web page: http://www.clifford.at/yosys/documentation.html (scroll down)"}}
{"actor":{"display_login":"cliffordwolf"}}