python-emails icon indicating copy to clipboard operation
python-emails copied to clipboard

Adding documentation: handcrafted .rst files vs. Sphinx autodoc?

Open dalepotter opened this issue 8 years ago • 1 comments

I noticed documentation is listed as the first todo on the docs homepage.

Is there any preference, or considerations, for what should be covered or how this should be added?

From a user point-of-view, I would have found full documentation on the available params for the main functions useful: emails.Message, emails.html, emails.attach and emails.send for example.

To document these functions, it would seem the options are adding to the existing using standalone .rst files or perhaps using Sphinx autodoc?

Happy to begin writing, but keen to make sure it fits in with the desired way of doing this...

dalepotter avatar Apr 07 '17 19:04 dalepotter

Just wonder if you had any thoughts on this @lavr - I'd be happy to help write some docs, but want to make sure that this would be in a useful format.

dalepotter avatar Jun 13 '17 12:06 dalepotter