Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
dalepotter opened this issue Apr 7, 2017 · 1 comment
Open

Comments

@dalepotter
Copy link
Contributor

dalepotter commented Apr 7, 2017

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
Copy link
Contributor Author

dalepotter commented Jun 13, 2017

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant