zeekay / decorum

Python decorator helper library.
MIT License
14 stars 2 forks source link

Add Sphinx documentation #9

Open benoitbryon opened 10 years ago

benoitbryon commented 10 years ago

What about having a Sphinx documentation? Not "just a README"? Here are some advantages:

benoitbryon commented 10 years ago

@zeekay: I volunteer to setup Sphinx documentation (see also #8). But, it is quite a big change, so I'd prefer you agree before I start. I mean, tell me whether you would consider a pull-request with Sphinx or you definitely want to keep docs in a single README ;)

zeekay commented 10 years ago

If you love Sphinx, I'm down. I've used it on larger projects...seems a tad overkill here (unless functionality significantly expands). I'll defer to you, as you'd be integrating it.

Plus I can always use whatever you add as a template for my other projects, so that's a win for me ;)