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

Add settings section to docs #142

Merged
merged 9 commits into from
Sep 29, 2023
Merged

Add settings section to docs #142

merged 9 commits into from
Sep 29, 2023

Conversation

rangelfinal
Copy link
Contributor

Add a settings section to README as suggested on #131 (comment)

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated
TEMPLATED_EMAIL_BACKEND # The backend that will send the email
TEMPLATED_EMAIL_TEMPLATE_DIR # The directory containing the templates, use '' if using the top level
TEMPLATED_EMAIL_FILE_EXTENSION # The file extension of the template files
TEMPLATED_EMAIL_AUTO_PLAIN # Disable the behavior of calculating the plain part from the html part of the email when `html2text <https://pypi.python.org/pypi/html2text>` is installed
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Disable or Enable? True means enable or disable here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated to display the default value of True and updated text to Set to false to disable the behavior to make it clearer that True enables the behavior and False disables it

README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
Copy link
Member

@fjsj fjsj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! Please check comments

Copy link
Member

@fjsj fjsj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved. But seems tests have errors? Please check if main suffers from the same issue.

@rangelfinal rangelfinal merged commit 43ed02a into develop Sep 29, 2023
4 checks passed
@fjsj fjsj deleted the docs/settings branch September 29, 2023 17:32
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

Successfully merging this pull request may close these issues.

2 participants