[{"data":1,"prerenderedAt":425},["ShallowReactive",2],{"project-20800157":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":42,"post_text":44,"what":45,"said":96,"maker_in_thread":183,"shape":191,"grid":196,"attempts":388,"same_week":389,"maker_shows":43,"maker_hidden":417,"reader_version":418,"card":419},"20800157","portray","Zero-Config Documentation Websites for Python","title","Show HN: Zero-Config Documentation Websites for Python","https:\u002F\u002Ftimothycrosley.github.io\u002Fportray\u002F","timothycrosley.github.io","timothycrosley",1566829847,2019,233,81,152,2195,7,"notable","dev_tools","documentation generator","cli",[24,25,26,27],"python documentation","sphinx alternative","markdown docs","docstring","mixed",0.163,{"positive":31,"neutral":32,"mixed":33,"critical":18},9,12,1,29,{"execution":36,"idea":38,"design":41},{"positive":33,"critical":37},3,{"positive":39,"critical":40},2,0,{"positive":39,"critical":33},[37,40,37,37,40,40,40,40,43,43,43,43,33,33,33,43,37,43,37,43,40,43,40,40,40,40,40,40,40,40,40,40,33,40,33,33,37,37,37,37],5,null,{"problem":46,"audience":58,"pricing":44,"motivation":62,"time_to_build":72,"stack":76,"openness":94,"stage":95,"team_size":94},{"value":47,"source":48,"evidence":49},"Generating Python documentation websites without Sphinx configuration","commenter",[50,54],{"id":51,"by":52,"text":53},"20802250","gillesjacobs","This is great! You hit the need for configless docsites that many Pythonistas who are in data science and research have: we write a lot of experimental and prototype code.…",{"id":55,"by":56,"text":57},"20801906","danking00","Tried this on our project, GitHub.com\u002Fhail-is\u002Fhail. Sphinx is a persistent thorn in our side, but we've made it work. A couple things I had to do to get this working: - something…",{"value":59,"source":48,"evidence":60},"Python developers, including data science and research programmers",[61],{"id":51,"by":52,"text":53},{"value":63,"source":64,"evidence":65},"Sphinx is frustrating; wanted simpler Markdown docs with no config","maker",[66,69],{"id":67,"by":11,"text":68},"20802118","Thanks so much for this great feedback! I haven't done any speed optimization on portray yet - as both at work and online I tend to organize my own projects as small self…",{"id":70,"by":11,"text":71},"20802211","The biggest differences between Sphinx-doc and portray: - Markdown - Zero Config required - Focus on Simplicity https:\u002F\u002Ftimothycrosley.com\u002Fproject-2-portray goes into why I…",{"value":73,"source":64,"evidence":74},"A week",[75],{"id":67,"by":11,"text":68},[77,82,88],{"value":78,"source":79,"evidence":80},"Python","inferred",[81],{"id":55,"by":56,"text":57},{"value":83,"source":64,"evidence":84},"MkDocs",[85],{"id":86,"by":11,"text":87},"20802222","portray uses MkDocs default search plugin which uses lunr.js behind the scenes.",{"value":89,"source":64,"evidence":90},"pdocs (pdoc fork)",[91],{"id":92,"by":11,"text":93},"20864665","The change away from pdoc3 and to a new fork of the original pdoc (called pdocs) has landed:…","unknown","beta",{"praise":97,"objections":112,"requests":146,"questions":155,"alternatives":170},[98,102],{"value":99,"source":48,"evidence":100},"Good mobile layout and search",[101],{"id":55,"by":56,"text":57},{"value":103,"source":48,"evidence":104},"Compatible with MkDocs themes",[105,109],{"id":106,"by":107,"text":108},"20801500","hultner","Very neat, I especially like it's compability with mkdocs-themes. Will try this out on some project :)",{"id":110,"by":11,"text":111},"20802128","https:\u002F\u002Ftimothycrosley.github.io\u002Fportray\u002Fdocs\u002Fquick_start\u002F4.-configuration\u002F portray is compatible with all MkDocs themes and plugins out-of-the-box",[113,127,132,142],{"value":114,"source":48,"evidence":115},"Swastika-like symbol in site footer and pdoc3 dependency raised concerns",[116,120,123],{"id":117,"by":118,"text":119},"20803008","isbjorn16","I was super pumped by this, and took some time to look into pdoc3 too. - https:\u002F\u002Fgithub.com\u002Fpdoc3\u002Fpdoc\u002Fissues\u002F87 - https:\u002F\u002Fgithub.com\u002Fpdoc3\u002Fpdoc\u002Fissues\u002F64 That's a hard pass from…",{"id":121,"by":118,"text":122},"20803706","It stopped being an innocent decision once it was pointed out and he doubled down. Put another way: I cannot put my or my employer's interests in Western markets at risk because…",{"id":124,"by":125,"text":126},"20805251","lucasmullens","His github profile picture is the swastika counter-clockwise. It's very clear from that his intention is to include things that appear like the Nazi swastika but are technically…",{"value":128,"source":64,"evidence":129},"Only Markdown supported, no reStructuredText",[130,131],{"id":67,"by":11,"text":68},{"id":51,"by":52,"text":53},{"value":133,"source":48,"evidence":134},"Requires packaged project; needs setup.py or pyproject",[135,139],{"id":136,"by":137,"text":138},"20803421","MadWombat","I am confused, all I get is \"No Python project found in the given directory\".",{"id":140,"by":137,"text":141},"20804551","my project doesn't have a setup.py because it is not intended for packaging and it doesn't have a pyproject.yaml because to be honest, this is the first time I heard about such a…",{"value":143,"source":48,"evidence":144},"Slow generation on large projects",[145],{"id":55,"by":56,"text":57},[147,151],{"value":148,"source":48,"evidence":149},"Support reStructuredText",[150],{"id":51,"by":52,"text":53},{"value":152,"source":48,"evidence":153},"Handle forward references in type hints",[154],{"id":55,"by":56,"text":57},[156,163],{"value":157,"source":48,"evidence":158},"How does it compare to Sphinx",[159],{"id":160,"by":161,"text":162},"20800833","dragonsh","My team at present use sphinx-doc[1] and generate both HTML and PDF. We write the documentation as part of the code using docstring and then other documents manually in rst. We…",{"value":164,"source":48,"evidence":165},"How is search implemented",[166],{"id":167,"by":168,"text":169},"20801793","amjith","How is the search implemented?",[171,176,180],{"value":172,"source":48,"evidence":173},"Sphinx",[174,175],{"id":160,"by":161,"text":162},{"id":55,"by":56,"text":57},{"value":177,"source":48,"evidence":178},"pdoc3",[179],{"id":117,"by":118,"text":119},{"value":83,"source":64,"evidence":181},[182],{"id":86,"by":11,"text":87},{"comments":184,"answered":43,"key":185},11,[186,187,188],{"id":67,"text":68},{"id":70,"text":71},{"id":189,"text":190},"20803185","Thanks! > Are you planning to support Restructured Text next to Markdown? I will look into supporting this, I agree that it definitely makes sense as a feature!",{"commenters":192,"max_depth":193,"maker_replies":184,"first_comment_mins":194,"lifespan_hours":195},44,6,31,245,[197,199,201,204,208,212,216,218,221,225,229,232,234,237,238,240,241,245,250,254,257,260,261,263,266,267,269,272,275,277,278,281,283,285,290,292,294,297,298,300,302,305,308,310,313,316,319,321,323,326,329,332,334,337,339,341,344,347,350,353,354,357,359,362,365,367,369,371,373,376,378,380,383,385],[55,40,37,198,56,40],"project\u002Fmixed\u002Fexecution",[67,40,40,200,11,33],"maker\u002Fneutral\u002Fnone",[202,40,40,203,56,40],"20802939","commenter\u002Fpositive\u002Fnone",[205,40,37,206,207,40],"20802194","project\u002Fneutral\u002Fexecution","scardine",[209,40,40,210,211,40],"20802266","other\u002Fneutral\u002Fnone","pokeymcsnatch",[213,40,40,214,215,40],"20802664","commenter\u002Fneutral\u002Fnone","kfoley",[160,33,37,217,161,40],"project\u002Fneutral\u002Fnone",[219,33,40,214,220,40],"20801126","DanFeldman",[222,33,40,223,224,40],"20802168","other\u002Fneutral\u002Fdocs","susam",[226,33,40,227,228,40],"20801674","other\u002Fneutral\u002Fidea","weberc2",[230,33,40,214,231,40],"20801736","carapace",[233,33,40,227,228,40],"20802358",[235,33,40,210,236,40],"20808511","baylessj",[70,33,40,217,11,33],[51,39,43,239,52,40],"project\u002Fpositive\u002Fidea",[189,39,40,200,11,33],[242,37,43,243,244,40],"20800420","project\u002Fpositive\u002Fnone","noobiemcfoob",[246,247,37,248,249,40],"20800923",4,"project\u002Fneutral\u002Fdesign","contravariant",[251,247,43,252,253,40],"20801675","project\u002Fpositive\u002Fdesign","ByThyGrace",[255,247,40,210,256,40],"20801843","jedberg",[258,247,40,259,11,33],"20803296","maker\u002Fneutral\u002Fdesign",[106,43,43,243,107,40],[136,193,33,262,137,40],"project\u002Fcritical\u002Fexecution",[264,193,40,265,11,33],"20803525","maker\u002Fneutral\u002Fexecution",[140,193,33,262,137,40],[268,193,40,206,11,33],"20890036",[270,193,33,262,271,40],"20809622","brorfred",[273,18,43,239,274,40],"20806159","peteretep",[167,276,37,217,168,40],8,[86,276,40,200,11,33],[279,31,37,248,280,40],"20801948","fucking_tragedy",[110,31,40,282,11,33],"maker\u002Fpositive\u002Fdesign",[284,31,43,252,280,40],"20802135",[286,287,43,288,289,40],"20849217",10,"project\u002Fpositive\u002Fexecution","abakus",[117,184,33,291,118,40],"project\u002Fcritical\u002Fnone",[293,184,40,200,11,33],"20803170",[295,184,43,296,118,40],"20803201","maker\u002Fpositive\u002Fnone",[92,184,40,217,11,33],[299,184,43,296,161,40],"20805851",[301,184,40,217,11,33],"20864666",[303,184,40,210,304,40],"20803206","mushufasa",[306,184,40,210,307,40],"20803246","wwwhizz",[309,184,40,210,304,40],"20803280",[311,184,40,210,312,40],"20804315","squeaky-clean",[314,184,40,210,315,40],"20804326","StavrosK",[317,184,40,210,318,40],"20804566","sooheon",[320,184,40,210,118,40],"20805973",[322,184,40,210,118,40],"20803406",[324,184,40,210,325,40],"20803621","avip",[327,184,40,210,328,40],"20804016","cdirkx",[330,184,40,210,331,40],"20806126","thrax",[333,184,40,210,325,40],"20807166",[335,184,40,210,336,40],"20803658","rat9988",[338,184,40,210,125,40],"20805263",[340,184,40,210,336,40],"20808807",[342,184,40,210,343,40],"20805315","greglindahl",[345,184,40,210,346,40],"20805937","rickycook",[348,184,40,210,349,40],"20807314","atoav",[351,184,40,210,352,40],"20803672","krilly",[121,184,33,291,118,40],[355,184,40,214,356,40],"20803885","peterwwillis",[358,184,40,214,118,40],"20804045",[360,184,33,291,361,40],"20805085","burntsushi",[363,184,40,214,364,40],"20803940","dragonwriter",[124,184,33,366,125,40],"maker\u002Fcritical\u002Fdesign",[368,184,37,248,356,40],"20803691",[370,184,37,248,118,40],"20803861",[372,184,40,210,331,40],"20806168",[374,184,37,248,375,40],"20804003","quickthrower2",[377,184,37,248,328,40],"20804107",[379,184,37,248,375,40],"20804228",[381,184,37,248,382,40],"20804788","procinct",[384,184,37,248,375,40],"20805549",[386,184,40,210,387,40],"20805091","wybiral",[],[390,394,399,403,408,412],{"id":391,"name":392,"points":393,"category":20},"20774322","monolith",640,{"id":395,"name":396,"points":397,"category":398},"20813557","fkMigration.jl",375,"languages",{"id":400,"name":401,"points":402,"category":20},"20817627","I created Postwoman",280,{"id":404,"name":405,"points":406,"category":407},"20798003","Wobaka",275,"web_saas",{"id":409,"name":410,"points":411,"category":407},"20790129","Sourcery",230,{"id":413,"name":414,"points":415,"category":416},"20811287","Lunch Money",229,"productivity",false,"v2",{"id":420,"name":5,"line":6,"ai":417,"cat":20,"year":13,"points":14,"comments":15,"rec":28,"s":421,"top":18,"kw":422,"maker":11,"domain":10,"tier":19,"attempts":40,"strip":423,"url":9,"mix":424,"praise":99,"objection":114,"sub":21},20800157,0.16,[24,25,26,27],"3033000055551115353505000000000010113333",[31,32,33,18],1794036580197]