JonasSC / PythonistManifesto

A short introduction to programming with Python for advanced beginners
0 stars 1 forks source link

Suggest Sphinx instead of Doxypy #3

Open mgeier opened 9 years ago

mgeier commented 9 years ago

It's just so much better ...

You'll see when you use it for the manifesto itself (#2).

JonasSC commented 9 years ago

So far, Doxygen and Doxypy are the only documentation generators, I've worked with. I was so impressed, how well it works for the visualization toolkit, that I've never looked for something else.

But again, I think that you are right, and that Sphinx is the better documentation generator for Python projects. The possibility to format the generated documentation with reStructuredText might outweigh every feature, that Doxypy has more than Sphinx.

I'll switch the documentation of SuMPF to Sphinx, and after that, I'll probably be able to write a short HowTo for it in the manifesto