Skip to content

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

@dalepotter

Description

@dalepotter

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...

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions