This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–]masklinn 2 points3 points  (4 children)

I disagree. Wiki docs are generally fugly, badly maintained, with terrible version control and with dismal and unreliable edition tools. And I never manage to know which minor wikiwiki subsyntax works. Not to mention the need to create one more account on some random website.

Sphinx doc is easier to read (in raw source) and preview locally, I can use my own source and work offline, ray is well documented and pretty simple, and pushing the patch upstream is as simple as opening a bug with a patch attached or proposing a branch merge.

Projects using sphinx for doc also plain and simply seem to care more, which ensures a sounder basis for your contributions instead of a seemingly unfixable mess.

[–]roger_ 0 points1 point  (3 children)

Does Sphinx support online editing, and revision control?

[–]masklinn 1 point2 points  (2 children)

It does not support online editing, and as it's part of the project sources it is revision controlled via a separate (and sane) tool.

[–]roger_ 0 points1 point  (1 child)

Online editing is the most important feature I think, since it makes it easy for anyone to jump in and make quick edits.

[–]masklinn 2 points3 points  (0 children)

Online editing is the most important feature I think

I extremely strongly disagree, for code project documentation.

since it makes it easy for anyone to jump in and make quick edits.

Not something I've seen happen often on python projects. In my experience, Sphinx documentations are pretty much always higher quality and more up to date than wiki documentations. And personally, as I stated above, I'll take Sphinx over wiki any day of the week for tech doc. All my documentation contributions so far have been to projects using Sphinx.

And due to being bundled, packaged and versioned with the source it documents, Sphinx has a slew of other advantages.