{"action":"created","issue":{"url":"https://api.github.com/repos/python-telegram-bot/python-telegram-bot/issues/338","repository_url":"https://api.github.com/repos/python-telegram-bot/python-telegram-bot","labels_url":"https://api.github.com/repos/python-telegram-bot/python-telegram-bot/issues/338/labels{/name}","comments_url":"https://api.github.com/repos/python-telegram-bot/python-telegram-bot/issues/338/comments","events_url":"https://api.github.com/repos/python-telegram-bot/python-telegram-bot/issues/338/events","html_url":"https://github.com/python-telegram-bot/python-telegram-bot/issues/338","id":164387354,"number":338,"title":"Documentation doesn't build.","user":{"login":"Faalentijn","id":8453949,"avatar_url":"https://avatars.githubusercontent.com/u/8453949?v=3","gravatar_id":"","url":"https://api.github.com/users/Faalentijn","html_url":"https://github.com/Faalentijn","followers_url":"https://api.github.com/users/Faalentijn/followers","following_url":"https://api.github.com/users/Faalentijn/following{/other_user}","gists_url":"https://api.github.com/users/Faalentijn/gists{/gist_id}","starred_url":"https://api.github.com/users/Faalentijn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Faalentijn/subscriptions","organizations_url":"https://api.github.com/users/Faalentijn/orgs","repos_url":"https://api.github.com/users/Faalentijn/repos","events_url":"https://api.github.com/users/Faalentijn/events{/privacy}","received_events_url":"https://api.github.com/users/Faalentijn/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2016-07-07T19:22:19Z","updated_at":"2016-07-07T20:48:20Z","closed_at":null,"body":"<!--\r\nThanks for reporting issues of python-telegram-bot!\r\nTo make it easier for us to help you please enter detailed information below.\r\n-->\r\n### Steps to reproduce\r\n1. Go to Docs/\r\n\r\n2. make info\r\n\r\n### Expected behaviour\r\nThe outputted file contains the documentation for python-telegram-bot in info format.\r\n\r\n### Actual behaviour\r\nThe outputted file is empty. The exception for this is when you are building the html files.\r\n\r\n### Configuration\r\n**Operating System:**\r\nGNU/Linux\r\n\r\n**Version of Python:**\r\nPython 3.4.4\r\n\r\n**Version of python-telegram-bot:**\r\nFresh clone.\r\n\r\n**Version of Sphinx**\r\n1.3.5\r\n\r\nThe fix seems to be to either add modules.srt or telegram.srt to the index.srt file. \r\n\r\nI've also noticed that there is some inconsistent naming in the documentation. For example you've telegram.ext.handler.rst and telegram.inlinequeryresultcachedmpeg4gif.rst. I'm not sure whether this is a bug or intended behaviour.\r\n"},"comment":{"url":"https://api.github.com/repos/python-telegram-bot/python-telegram-bot/issues/comments/231202667","html_url":"https://github.com/python-telegram-bot/python-telegram-bot/issues/338#issuecomment-231202667","issue_url":"https://api.github.com/repos/python-telegram-bot/python-telegram-bot/issues/338","id":231202667,"user":{"login":"Faalentijn","id":8453949,"avatar_url":"https://avatars.githubusercontent.com/u/8453949?v=3","gravatar_id":"","url":"https://api.github.com/users/Faalentijn","html_url":"https://github.com/Faalentijn","followers_url":"https://api.github.com/users/Faalentijn/followers","following_url":"https://api.github.com/users/Faalentijn/following{/other_user}","gists_url":"https://api.github.com/users/Faalentijn/gists{/gist_id}","starred_url":"https://api.github.com/users/Faalentijn/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Faalentijn/subscriptions","organizations_url":"https://api.github.com/users/Faalentijn/orgs","repos_url":"https://api.github.com/users/Faalentijn/repos","events_url":"https://api.github.com/users/Faalentijn/events{/privacy}","received_events_url":"https://api.github.com/users/Faalentijn/received_events","type":"User","site_admin":false},"created_at":"2016-07-07T20:48:20Z","updated_at":"2016-07-07T20:48:20Z","body":"> If you're referring to the .ext. part, that is because the handler file is located in the telegram.ext submodule. If that is the wrong way to document submodules (or there is a more common way to do it), please let me know. This is my doing ^^\r\n\r\nI'm not sure what the common way of doing it is (I can't seem to find a standard and I'm quite green) but they way it is done right now seems kind of silly.\r\n\r\nThe documentation in its current state is more of a reference but the way it is laid out makes it kind of difficult. Mainly the lack of grouping like you're doing with `.ext` (the .ext defines a subdomain). Without grouping you can easily get a difficult to find things.\r\n\r\nSo for instance rather than having the following layout:\r\n`telegram.audio module\r\ntelegram.base module\r\n<snip>\r\ntelegram.ext package (a group of modules)\r\n<snip>\r\ntelegram.inlinequeryresult module\r\ntelegram.inlinequeryresultarticle module\r\ntelegram.inlinequeryresultaudio module\r\ntelegram.inlinequeryresultcachedaudio module\r\ntelegram.inlinequeryresultcacheddocument module\r\n`\r\nWhy don't you do something like this:\r\n`\r\nAudio / telegram.audio module\r\nBase / telegram.base.module\r\n<snip>\r\nExt. module / telegram.ext package\r\n<snip>\r\nInline query package (with the inline query modules inside)\r\n`\r\n\r\nThis would make it a lot easier to find the documentation you want/need."}}
{"actor":{"display_login":"Faalentijn"}}