{"action":"created","issue":{"url":"https://api.github.com/repos/sympy/sympy/issues/8889","labels_url":"https://api.github.com/repos/sympy/sympy/issues/8889/labels{/name}","comments_url":"https://api.github.com/repos/sympy/sympy/issues/8889/comments","events_url":"https://api.github.com/repos/sympy/sympy/issues/8889/events","html_url":"https://github.com/sympy/sympy/issues/8889","id":55525783,"number":8889,"title":"Code generation documentation needs a major update","user":{"login":"moorepants","id":276007,"avatar_url":"https://avatars.githubusercontent.com/u/276007?v=3","gravatar_id":"","url":"https://api.github.com/users/moorepants","html_url":"https://github.com/moorepants","followers_url":"https://api.github.com/users/moorepants/followers","following_url":"https://api.github.com/users/moorepants/following{/other_user}","gists_url":"https://api.github.com/users/moorepants/gists{/gist_id}","starred_url":"https://api.github.com/users/moorepants/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/moorepants/subscriptions","organizations_url":"https://api.github.com/users/moorepants/orgs","repos_url":"https://api.github.com/users/moorepants/repos","events_url":"https://api.github.com/users/moorepants/events{/privacy}","received_events_url":"https://api.github.com/users/moorepants/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/sympy/sympy/labels/Documentation","name":"Documentation","color":"c7def8"},{"url":"https://api.github.com/repos/sympy/sympy/labels/Easy%20to%20Fix","name":"Easy to Fix","color":"009800"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":4,"created_at":"2015-01-26T19:28:30Z","updated_at":"2015-01-27T16:58:52Z","closed_at":null,"body":"We now have C, Fortran, and Octave/Matlab code generators plus recent support was added for generating code for Matrix and MatrixSymbol objects. The current documentation on code generation is pretty sparse.\r\n\r\nThere is also support for Theano that isn't well documented in the prose documentation.\r\n\r\nThis is the main thing we have now: http://docs.sympy.org/latest/modules/numeric-computation.html (besides api docs, which are pretty good).\r\n\r\nIt would be great to have some thorough documentation showing how to use the code printing, code generators, and autowrapping features. These would probably get more use if we had nice docs.\r\n\r\nThis could be a nice task for a new contributor."},"comment":{"url":"https://api.github.com/repos/sympy/sympy/issues/comments/71683846","html_url":"https://github.com/sympy/sympy/issues/8889#issuecomment-71683846","issue_url":"https://api.github.com/repos/sympy/sympy/issues/8889","id":71683846,"user":{"login":"moorepants","id":276007,"avatar_url":"https://avatars.githubusercontent.com/u/276007?v=3","gravatar_id":"","url":"https://api.github.com/users/moorepants","html_url":"https://github.com/moorepants","followers_url":"https://api.github.com/users/moorepants/followers","following_url":"https://api.github.com/users/moorepants/following{/other_user}","gists_url":"https://api.github.com/users/moorepants/gists{/gist_id}","starred_url":"https://api.github.com/users/moorepants/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/moorepants/subscriptions","organizations_url":"https://api.github.com/users/moorepants/orgs","repos_url":"https://api.github.com/users/moorepants/repos","events_url":"https://api.github.com/users/moorepants/events{/privacy}","received_events_url":"https://api.github.com/users/moorepants/received_events","type":"User","site_admin":false},"created_at":"2015-01-27T16:58:51Z","updated_at":"2015-01-27T16:58:51Z","body":"The page you link to is mostly API documentation. The first bit is ok but needs to be expanded. We'd really like a nice tutorial/prose style page that shows how you can use the code gen. I'd start by reading the docstrings in the codegen module and checking out the examples directory to see if there are any examples.\r\n\r\nThe matrices docs give a good example by what I mean by \"prose\" documentation.\r\n\r\nSome of the topics that need to be covered:\r\n\r\n- printing all types of of code and using the various printer options for fortran, C, js, etc\r\n- codegen examples for fortran, C, and octave/matlab (show how different optional args affect output)\r\n- examples for autowrap and ufuncify using the different backends and options"}}