News for hackers. Stuff that matters.
Re:Python overtakes JavaScript as most questioned language o... by peteretep on Saturday April 20, 2019 @05:44AM (#19705626)
Coming from Perl, Python library documentation makes me want to tear my eyes out. No I don’t want a cutesy fucking module homepage, I want reference documentation with some examples. Authoring PyDoc was the worst experience too. No I don’t want to install and configure a static site generator in order to have rich text documentation.
Re:Python overtakes JavaScript as most questioned language o... by kissgyorgy on Saturday April 20, 2019 @06:22AM (#19705732)
It's strange to see this is your experience, because I had the exact opposite: Python documentations are usually very comprehensive, nicely formatted. Important projects have very good documentations and setting up a new documentation is very easy with Sphinx. Maybe you should try it again, it might have changed a lot since you looked it.
Re:Python overtakes JavaScript as most questioned language o... by peteretep on Saturday April 20, 2019 @06:49AM (#19705822)
I looked at it last a month ago. It was terrible.

> setting up a new documentation is very easy with Sphinx

As per my original comment, the idea that documentation should require some kind of external markdown static site generator is bizarro land.

Re:Python overtakes JavaScript as most questioned language o... by jefftk on Saturday April 20, 2019 @07:25AM (#19705939)
How would you want this to work? The alternatives to Sphinx I've used (Javadoc, Doxygen) more or less work the same way.
Re:Python overtakes JavaScript as most questioned language o... by mjw1007 on Saturday April 20, 2019 @08:07AM (#19706086)
I think there's a big difference.

Sphinx starts from the point of view that you're going to write your documentation as if you were writing a book, then on top of that it has some optional features for pulling in information from source files.

Most of the others start from the view that you're autogenerating documentation from source-code comments, and on top of that there are some optional features for pulling in some extra content from documentation-specific files.

I think the Sphinx way tends to produce better documentation in the long run, but it takes more effort to get to something just-about-adequate.

Re:Python overtakes JavaScript as most questioned language o... by kissgyorgy on Saturday April 20, 2019 @08:14AM (#19706119)
I understand your point, and Go is probably better in this regard, but it's pretty easy to get started with Sphinx with autogenerating documentation from code. You don't have to manually write anything.
Re:Python overtakes JavaScript as most questioned language o... by peteretep on Saturday April 20, 2019 @10:55AM (#19706819)
Exactly on the money. I want to document my library, not create a website.
Re:Python overtakes JavaScript as most questioned language o... by corv on Saturday April 20, 2019 @08:26AM (#19706163)
Having just had the pleasure of using Sphinx for the first time, I can only underline what you wrote.
Re:Python overtakes JavaScript as most questioned language o... by zbentley on Saturday April 20, 2019 @11:05AM (#19706885)
Some python documentation conventions are weird, to be sure. But I’d rather have an eternity of Sphinx build toolchains than the hell that is making POD/Perldoc work for medium-to-large projects (or small ones, for that matter).
Re:Python overtakes JavaScript as most questioned language o... by peteretep on Saturday April 20, 2019 @11:32PM (#19710397)
> the hell that is making POD/Perldoc work for medium-to-large projects

Such as?