Hi Damian,
I explored sphinx and tried it on stem these days, and it seemed pretty handy. I think a good way to produce nice documentation for stem is to create a page for each module manually, write an introduction by hand, and use autoclass / autofunction / autoexception in the autodoc extension to create API docs. automodule seems too general and does not work well with module's docstring in stem since it is not written in reST format, so I don't like it. What do you suggest? And how's your progress now?
Cheers, Beck
Hi Beck. It's a pity that you disappeared from irc, I tried to tell you there that I was actively looking into Sphinx too and had some discussions in #tor-dev about if we should switch to reStructuredText.
I'm currently converting all of our pydocs and will probably be done tomorrow... https://gitweb.torproject.org/user/atagar/stem.git/shortlog/refs/heads/sphin...
I'm probably doing a poor job of coordinating things. Thoughts on what we could do better to avoid stepping on each other's toes?
Oh, that's absolutely my fault that has not contacted you or showed up on irc this week. I didn't spend too much time on it thought, so things are not that bad. Do you need any help on this, or you can complete all the work by yourself and I should move to another task (maybe events)?
Beck
Do you need any help on this, or you can complete all the work by yourself and I should move to another task (maybe events)?
Nope, I should be fine finishing this on my own. Events would be a great thing to work on next. I haven't written any examples but hopefully it won't be too hard to figure out - let me know if you have any questions!
I'd suggest starting with BW events since they'll be the easiest to test (due to being reliably emitted every second).
Cheers! -Damian