From a12197eb4edfa286e048a312258ca880b92f0e45 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sviatoslav=20Sydorenko=20=28=D0=A1=D0=B2=D1=8F=D1=82=D0=BE?= =?UTF-8?q?=D1=81=D0=BB=D0=B0=D0=B2=20=D0=A1=D0=B8=D0=B4=D0=BE=D1=80=D0=B5?= =?UTF-8?q?=D0=BD=D0=BA=D0=BE=29?= Date: Mon, 4 Mar 2024 00:07:15 +0100 Subject: [PATCH] Fix an incorrect statement in philosophy about Towncrier only supporting RST The reality is that it is Jinja2 template based and can produce Markdown as well. It just used to be poorly documented. I helped Hynek figure it out for the attrs project at some point. --- docs/philosophy.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/philosophy.rst b/docs/philosophy.rst index 269d4bc..92f5110 100644 --- a/docs/philosophy.rst +++ b/docs/philosophy.rst @@ -37,7 +37,9 @@ None fully embodied scriv's philopsophy. Tools most similar to scriv: - `towncrier`_: built for Twisted, with some unusual specifics: fragment type - is the file extension, issue numbers in the file name. Only .rst files. + is the file extension, issue numbers in the file name. Defaults to using + ``.rst`` files, but can be configured to produce Markdown or any other + output format, provided enough configuration. - `blurb`_: built for CPython development, specific to their workflow: issue numbers from bugs.python.org, only .rst files.