{"action":"created","issue":{"url":"https://api.github.com/repos/stephenmcd/mezzanine/issues/1148","labels_url":"https://api.github.com/repos/stephenmcd/mezzanine/issues/1148/labels{/name}","comments_url":"https://api.github.com/repos/stephenmcd/mezzanine/issues/1148/comments","events_url":"https://api.github.com/repos/stephenmcd/mezzanine/issues/1148/events","html_url":"https://github.com/stephenmcd/mezzanine/issues/1148","id":47819398,"number":1148,"title":"Improve API Documentation","user":{"login":"prikhi","id":1304102,"avatar_url":"https://avatars.githubusercontent.com/u/1304102?v=3","gravatar_id":"","url":"https://api.github.com/users/prikhi","html_url":"https://github.com/prikhi","followers_url":"https://api.github.com/users/prikhi/followers","following_url":"https://api.github.com/users/prikhi/following{/other_user}","gists_url":"https://api.github.com/users/prikhi/gists{/gist_id}","starred_url":"https://api.github.com/users/prikhi/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/prikhi/subscriptions","organizations_url":"https://api.github.com/users/prikhi/orgs","repos_url":"https://api.github.com/users/prikhi/repos","events_url":"https://api.github.com/users/prikhi/events{/privacy}","received_events_url":"https://api.github.com/users/prikhi/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/stephenmcd/mezzanine/labels/docs","name":"docs","color":"d7e102"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":17,"created_at":"2014-11-05T10:12:20Z","updated_at":"2015-10-03T14:21:28Z","closed_at":null,"body":"I would love it if the docs took advantage of some more of Sphinx's features, like cross-references and info field lists: http://sphinx-doc.org/domains.html#the-python-domain\r\n\r\nI'm willing to get started on this, I just want to get the sign off before putting any work into it.\r\nWould you prefer a single(squashed?) PR or a PR per app?\r\n\r\nAnd is there opposition to enabling the `sphinx.ext.viewcode` Sphinx extension? I find this helpful as it keeps me from having to jump between mezzanines docs when I need the overview and the code when I need the details. But I wouldn't be sad if this got shot down, I can always just build them locally...\r\n\r\n## mezzanine/\r\n- [ ] accounts\r\n- [ ] blog\r\n- [ ] boot\r\n- [ ] conf\r\n- [ ] core\r\n- [ ] forms\r\n- [ ] galleries\r\n- [ ] generic\r\n- [ ] mobile\r\n- [ ] pages\r\n- [ ] template\r\n- [ ] twitter\r\n- [ ] utils\r\n\r\n## docs/\r\n- [ ] admin-customization\r\n- [ ] blog-importing\r\n- [ ] caching-strategy\r\n- [ ] colophon\r\n- [ ] configuration\r\n- [ ] content-architecture\r\n- [ ] deplyment\r\n- [ ] device-handling\r\n- [ ] fabfile\r\n- [ ] frequently-asked-questions\r\n- [ ] index\r\n- [ ] inline-editing\r\n- [ ] model-customization\r\n- [ ] model-graph\r\n- [ ] multi-tenancy\r\n- [ ] overview\r\n- [ ] packages\r\n- [ ] search-engine\r\n- [ ] settings\r\n- [ ] twitter-integration\r\n- [ ] user-accounts\r\n- [ ] utilities\r\n\r\nThis is a lot and my mezzanine dev time is limited so I will be slowly working on this over at prikhi/mezzanine@c19b41b73559586a7894a7b9fa5e800b6cdfff34\r\n"},"comment":{"url":"https://api.github.com/repos/stephenmcd/mezzanine/issues/comments/145253038","html_url":"https://github.com/stephenmcd/mezzanine/issues/1148#issuecomment-145253038","issue_url":"https://api.github.com/repos/stephenmcd/mezzanine/issues/1148","id":145253038,"user":{"login":"auvipy","id":6212603,"avatar_url":"https://avatars.githubusercontent.com/u/6212603?v=3","gravatar_id":"","url":"https://api.github.com/users/auvipy","html_url":"https://github.com/auvipy","followers_url":"https://api.github.com/users/auvipy/followers","following_url":"https://api.github.com/users/auvipy/following{/other_user}","gists_url":"https://api.github.com/users/auvipy/gists{/gist_id}","starred_url":"https://api.github.com/users/auvipy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/auvipy/subscriptions","organizations_url":"https://api.github.com/users/auvipy/orgs","repos_url":"https://api.github.com/users/auvipy/repos","events_url":"https://api.github.com/users/auvipy/events{/privacy}","received_events_url":"https://api.github.com/users/auvipy/received_events","type":"User","site_admin":false},"created_at":"2015-10-03T14:21:28Z","updated_at":"2015-10-03T14:21:28Z","body":"is it gonna be complete anytime soon?"}}