{"action":"created","issue":{"url":"https://api.github.com/repos/BurntSushi/pdoc/issues/30","repository_url":"https://api.github.com/repos/BurntSushi/pdoc","labels_url":"https://api.github.com/repos/BurntSushi/pdoc/issues/30/labels{/name}","comments_url":"https://api.github.com/repos/BurntSushi/pdoc/issues/30/comments","events_url":"https://api.github.com/repos/BurntSushi/pdoc/issues/30/events","html_url":"https://github.com/BurntSushi/pdoc/pull/30","id":58254234,"number":30,"title":"support for markdown output","user":{"login":"Friz-zy","id":870618,"avatar_url":"https://avatars.githubusercontent.com/u/870618?v=3","gravatar_id":"","url":"https://api.github.com/users/Friz-zy","html_url":"https://github.com/Friz-zy","followers_url":"https://api.github.com/users/Friz-zy/followers","following_url":"https://api.github.com/users/Friz-zy/following{/other_user}","gists_url":"https://api.github.com/users/Friz-zy/gists{/gist_id}","starred_url":"https://api.github.com/users/Friz-zy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/Friz-zy/subscriptions","organizations_url":"https://api.github.com/users/Friz-zy/orgs","repos_url":"https://api.github.com/users/Friz-zy/repos","events_url":"https://api.github.com/users/Friz-zy/events{/privacy}","received_events_url":"https://api.github.com/users/Friz-zy/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":10,"created_at":"2015-02-19T19:14:35Z","updated_at":"2016-03-28T20:39:19Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/BurntSushi/pdoc/pulls/30","html_url":"https://github.com/BurntSushi/pdoc/pull/30","diff_url":"https://github.com/BurntSushi/pdoc/pull/30.diff","patch_url":"https://github.com/BurntSushi/pdoc/pull/30.patch"},"body":"Goals: add markdown as output format because readthedocs has support only for rst and md formats right now. \r\n* add cli options: --markdown, --walk-path, --walk-path-followlinks\r\n* change cli option --html-dir to --output-dir\r\n* add md.mako template based on text.mako\r\n* you can now specify many modules per one executing\r\n* walk-path option allows recursively find all modules in path via __init__.py file, '.py' extension and even via 'python' word in the shebang\r\n"},"comment":{"url":"https://api.github.com/repos/BurntSushi/pdoc/issues/comments/202572310","html_url":"https://github.com/BurntSushi/pdoc/pull/30#issuecomment-202572310","issue_url":"https://api.github.com/repos/BurntSushi/pdoc/issues/30","id":202572310,"user":{"login":"jvantuyl","id":101,"avatar_url":"https://avatars.githubusercontent.com/u/101?v=3","gravatar_id":"","url":"https://api.github.com/users/jvantuyl","html_url":"https://github.com/jvantuyl","followers_url":"https://api.github.com/users/jvantuyl/followers","following_url":"https://api.github.com/users/jvantuyl/following{/other_user}","gists_url":"https://api.github.com/users/jvantuyl/gists{/gist_id}","starred_url":"https://api.github.com/users/jvantuyl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/jvantuyl/subscriptions","organizations_url":"https://api.github.com/users/jvantuyl/orgs","repos_url":"https://api.github.com/users/jvantuyl/repos","events_url":"https://api.github.com/users/jvantuyl/events{/privacy}","received_events_url":"https://api.github.com/users/jvantuyl/received_events","type":"User","site_admin":false},"created_at":"2016-03-28T20:39:19Z","updated_at":"2016-03-28T20:39:19Z","body":":(\n\nI agree to some extent about the config file concern. That said, in the absence of a plugin system, I don't see how not to bake this in.\n\nIn the long run, pdoc has two pieces of functionality:\n\n* documentation extractor\n* static site generator\n\nThere is a profound need in the Python community for the former and about a dozen entrenched (and valuable) implementations of the latter.\n\nThis pull exists to bridge pdoc into mkdocs which bridges fairly cleanly into readthedocs. My primary use case is that the Python community has sorely neglected automated API docs and I really need this so I don't have to maintain two sets of docs (in Sphinx and my code).\n\nWould you entertain something that doesn't do full mkdocs integration? Would you prefer some other plugin architecture? How can we make this happen, because epydoc doesn't cut it anymore and embedding pdoc-generated HTML is really incongruous."}}