Vineet pretty much told you what you have to do. And that's actually pretty
much it. sphinx-quickstart is pretty helpful as well to get you smoothly
started with things.
Now a couple of things from my experience of documentation and Sphinx:
1. A very general advice. Keep writing docs as you wr
Hi,
Basically there are 3 steps involved in this:
1. Write docstrings in your code using reStructuredText directives and
field lists that are recognized by Sphinx. See an example here
[1]. It's a good idea refer to docs of existing libs as Kracekumar
mentioned.
2. Enable the autodoc extens
Take a look at existing third party library like requests:
https://github.com/kennethreitz/requests/tree/master/docs
On Sun, May 25, 2014 at 11:43 PM, Nitin Kumar wrote:
> I need to document python code under github repo with Sphinx for auto doc
> generation. Anyone got good tips & tricks, samp
I need to document python code under github repo with Sphinx for auto doc
generation. Anyone got good tips & tricks, samples?
___
BangPypers mailing list
BangPypers@python.org
https://mail.python.org/mailman/listinfo/bangpypers
