[{"data":1,"prerenderedAt":251},["ShallowReactive",2],{"project-25903595":3},{"id":4,"name":5,"line":6,"line_source":7,"title":8,"url":9,"domain":10,"maker":11,"posted_at":12,"year":13,"points":14,"comments":15,"rank_in_year":16,"shown_in_year":17,"top":18,"tier":19,"category":20,"subcategory":21,"format":22,"keywords":23,"reception":28,"sentiment":29,"stance_mix":30,"scored_comments":34,"aspects":35,"strip":40,"post_text":43,"what":44,"said":83,"maker_in_thread":169,"shape":177,"grid":179,"attempts":214,"same_week":215,"maker_shows":41,"maker_hidden":244,"reader_version":245,"card":246},"25903595","Pdoc","A lightweight Python API documentation generator","title","Show HN: Pdoc, a lightweight Python API documentation generator","https:\u002F\u002Fpdoc.dev\u002F","pdoc.dev","mhils",1611585633,2021,45,18,910,2533,36,"shown","dev_tools","api documentation generator","cli",[24,25,26,27],"python documentation generator","api docs","docstrings","sphinx alternative","mixed",0,{"positive":31,"neutral":32,"mixed":33,"critical":31},2,4,1,9,{"idea":36,"docs":37,"design":38,"execution":39},{"positive":33,"critical":29},{"positive":29,"critical":29},{"positive":29,"critical":33},{"positive":33,"critical":33},[29,41,29,41,41,41,29,41,29,29,33,29,29,42,29,33,29,42],3,5,null,{"problem":45,"audience":56,"pricing":43,"motivation":65,"time_to_build":43,"stack":70,"openness":81,"stage":82,"team_size":81},{"value":46,"source":47,"evidence":48},"Generating API documentation from Python modules with a lightweight tool instead of Sphinx","commenter",[49,53],{"id":50,"by":51,"text":52},"25905689","Evidlo","Looks simpler than Sphinx. I may give it a try",{"id":54,"by":11,"text":55},"25903682","Hi HN! Some of you may remember @BurntSushi's pdoc tool, a lightweight alternative to Sphinx. We're a bit in an unfortunate situation with a hostile work assuming our name [1],…",{"value":57,"source":58,"evidence":59},"Python developers","inferred",[60,61],{"id":54,"by":11,"text":55},{"id":62,"by":63,"text":64},"25904400","woile","This is really awesome thanks for sharing. And it even supports markdown by default, fantastic! Some questions: - is it possible to include a folder with md files in the output?…",{"value":66,"source":67,"evidence":68},"Continue the legacy of BurntSushi's pdoc tool after a naming dispute with pdoc3","maker",[69],{"id":54,"by":11,"text":55},[71,75],{"value":72,"source":67,"evidence":73},"Python",[74],{"id":54,"by":11,"text":55},{"value":76,"source":67,"evidence":77},"Jinja2",[78],{"id":79,"by":11,"text":80},"25913460","What kind of JSON format would you be looking for? Is there some sort of standard I'm not aware of? Generally speaking it's quite easy to change the output format, one just needs…","unknown","launched",{"praise":84,"objections":103,"requests":122,"questions":142,"alternatives":151},[85,93],{"value":86,"source":47,"evidence":87},"Looks simpler than Sphinx",[88,89],{"id":50,"by":51,"text":52},{"id":90,"by":91,"text":92},"25905209","euler_angles","I recently tried to use pdoc on a system that can never have internet connectivity. Looks like pdoc implicitly expects internet connectivity because it wants to get at a bunch of…",{"value":94,"source":67,"evidence":95},"Standalone HTML output and modern Python 3 features",[96,100],{"id":97,"by":98,"text":99},"25904544","kingosticks","I hadn't heard of this and it looks great. But then I also came across pdocs[0]. Other than the 3rd bullet which looks outdated, how does the rest of the comparison[1] hold up?…",{"id":101,"by":11,"text":102},"25905247","pdoc produces completely standalone HTML files with no dependencies and no JS. Even the collapsible navigation on small screen sizes is implemented in CSS only. Take a look…",[104,111,116],{"value":105,"source":47,"evidence":106},"Requires Python 3.8 or later, which was a blocker for some users",[107],{"id":108,"by":109,"text":110},"25909233","jquaint","The python >3.8 requirement broke the use case for me. I know that there is support for creating API's on python 3.5+. It's just not worth it to upgrade to 3.8 to create docs and…",{"value":112,"source":47,"evidence":113},"Output depended on internet access for resources, though the maker says it is fully standalone",[114,115],{"id":90,"by":91,"text":92},{"id":101,"by":11,"text":102},{"value":117,"source":47,"evidence":118},"Only HTML output, no Markdown output",[119],{"id":120,"by":11,"text":121},"25904797","pdocs is what a friendly fork looks like, happy to see it. :) I've sent an email to Timothy a few days ago, I'd be more than happy to eventually join forces. We also invited the…",[123,130,138],{"value":124,"source":47,"evidence":125},"JSON output format",[126],{"id":127,"by":128,"text":129},"25910657","sthupukari","This looks great! Do you have plans on producing JSON output in addition to HTML output? I have a larger custom website in which I need to embed my Python documentation in. I…",{"value":131,"source":47,"evidence":132},"Markdown output and integration with mkdocs",[133,134],{"id":62,"by":63,"text":64},{"id":135,"by":136,"text":137},"25905193","kylebarron","Are you interested in adding support for Markdown output? We're using pdocs specifically so that we can integrate it inside mkdocs output. Example API docs from pdocs, rendered…",{"value":139,"source":47,"evidence":140},"Support for # or ## comment-style docs",[141],{"id":62,"by":63,"text":64},[143,147],{"value":144,"source":47,"evidence":145},"Can it include a folder of markdown files in the output?",[146],{"id":62,"by":63,"text":64},{"value":148,"source":47,"evidence":149},"Will Python 3.7 be supported?",[150],{"id":108,"by":109,"text":110},[152,159,163],{"value":153,"source":47,"evidence":154},"Sphinx",[155,158],{"id":156,"by":136,"text":157},"25905273","> integrating your API documentation into the rest of your website\u002Fdocs is definitely something that I have on the radar I think that Sphinx and mkdocs are the two most popular…",{"id":50,"by":51,"text":52},{"value":160,"source":47,"evidence":161},"pdocs",[162],{"id":97,"by":98,"text":99},{"value":164,"source":47,"evidence":165},"mkdocs with mkautodoc plugin",[166],{"id":167,"by":63,"text":168},"25906423","Mkdocs has a plugin to generate apidocs as well https:\u002F\u002Fgithub.com\u002Ftomchristie\u002Fmkautodoc",{"comments":170,"answered":42,"key":171},7,[172,173,176],{"id":54,"text":55},{"id":174,"text":175},"25904576","> is it possible to include a folder with md files in the output? Not yet, but integrating your API documentation into the rest of your website\u002Fdocs is definitely something that…",{"id":120,"text":121},{"commenters":34,"max_depth":42,"maker_replies":170,"first_comment_mins":170,"lifespan_hours":178},317,[180,182,184,186,188,189,191,192,194,196,200,202,203,205,207,208,210,213],[54,29,29,181,11,33],"project\u002Fpositive\u002Fnone",[62,29,41,183,63,29],"project\u002Fneutral\u002Fnone",[174,29,29,185,11,33],"project\u002Fneutral\u002Fdesign",[156,29,41,187,136,29],"project\u002Fneutral\u002Fidea",[167,29,41,187,63,29],[97,29,41,190,98,29],"project\u002Fneutral\u002Fdocs",[120,29,29,190,11,33],[135,29,41,193,136,29],"project\u002Fmixed\u002Fdesign",[195,29,29,185,11,33],"25905344",[197,29,29,198,199,29],"25941244","commenter\u002Fneutral\u002Fnone","timvdalen",[90,33,33,201,91,29],"project\u002Fcritical\u002Fdesign",[101,33,29,185,11,33],[204,33,29,198,91,29],"25906147",[127,31,42,206,128,29],"project\u002Fpositive\u002Fidea",[79,31,29,187,11,33],[108,41,33,209,109,29],"project\u002Fcritical\u002Fexecution",[211,41,29,212,11,33],"26057324","project\u002Fpositive\u002Fexecution",[50,32,42,212,51,29],[],[216,221,225,230,235,239],{"id":217,"name":218,"points":219,"category":220},"25872922","Iconduck",528,"creative",{"id":222,"name":223,"points":224,"category":220},"25885760","Filmulator",282,{"id":226,"name":227,"points":228,"category":229},"25902165","I made an alarm clock",271,"hardware",{"id":231,"name":232,"points":233,"category":234},"25879238","Rysolv",250,"web_saas",{"id":236,"name":237,"points":238,"category":20},"25870482","Timeflake",205,{"id":240,"name":241,"points":242,"category":243},"25889420","Gutensearch",202,"learning_science",false,"v2",{"id":247,"name":5,"line":6,"ai":244,"cat":20,"year":13,"points":14,"comments":15,"rec":28,"s":29,"top":18,"kw":248,"maker":11,"domain":10,"tier":19,"attempts":29,"strip":249,"url":9,"mix":250,"praise":86,"objection":105,"sub":21},25903595,[24,25,26,27],"030333030010050105",[31,32,33,31],1793991022755]