3 ms·
You found me out: I haven't actually tried to use sphinx-apidoc. Its help page seems to imply that it actually generates all the output HTML, not just a prefab
by irskep 13y ago
You found me out: I haven't actually tried to use sphinx-apidoc. Its help page seems to imply that it actually generates all the output HTML, not just a prefab Sphinx dir. Sorry for spreading misinformation.
You do have very good reasons for wanting a separate tool (or at the very least, for improving Sphinx's behavior for this use case). I think you can make those reasons clear in your docs without causing the sort of confusion I had. In my mind, pdoc's advantages are that (1) there really is no need for file-based configuration, and (2) (now that you've told me) it has superior discovery of instance variables. The hand-waving "I couldn't configure it" doesn't work in your favor.
I'm no stranger to how bad/strange Sphinx can be; I work on this: https://sphinx-better-theme.readthedocs.org/en/latest/ https://sphinx-better-theme.readthedocs.org/en/latest/
and I work with it a lot to write the docs for this project: http://mrjob.readthedocs.org/en/latest/ http://mrjob.readthedocs.org/en/latest/
and it's generally a monster to figure out the internals of.
- burntsushi 13y ago> I think you can make those reasons clear in your docs without causing the sort of confusion I had. ... The hand-waving "I couldn't configure it" doesn't work in your favor. Excellent suggestion. I'm still full of emotion after writing that rant, but when I calm down, I'll try and craft a section on "Why Not Sphinx" in my README. It's quite literally the only criticism I've received so far. I'll keep your interpretation of pdoc's advantages in mind. > and I work with it a lot to write the docs for this project: http://mrjob.readthedocs.org/en/latest/ http://mrjob.readthedocs.org/en/latest/ You have my compliments. That is really beautiful (in every sense) documentation---you are clearly not among those who aren't conscious of putting links in obvious places. :-)