From df131386cc87bd8777952526106083bc5cffd4cf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Edgar=20Ram=C3=ADrez=20Mondrag=C3=B3n?= Date: Fri, 26 Jan 2024 10:15:36 -0600 Subject: [PATCH] docs: Call out minimum recommended `cookiecutter` version See https://github.com/meltano/sdk/issues/2182#issuecomment-1912321145 --- docs/conf.py | 5 +++++ docs/dev_guide.md | 4 ++++ 2 files changed, 9 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index a784a46f5..519b2af0c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -117,7 +117,12 @@ "css/custom.css", ] +# -- Options for MyST -------------------------------------------------------- +# https://myst-parser.readthedocs.io/en/latest/configuration.html myst_heading_anchors = 3 +myst_enable_extensions = { + "colon_fence", +} redirects = { "porting.html": "guides/porting.html", diff --git a/docs/dev_guide.md b/docs/dev_guide.md index 316cca8ad..75dcf60dc 100644 --- a/docs/dev_guide.md +++ b/docs/dev_guide.md @@ -55,6 +55,10 @@ pipx install poetry pipx install tox ``` +:::{tip} +The minimum recommended version of cookiecutter is `2.2.0` (released 2023-07-06). +::: + Now you can initialize your new project with the Cookiecutter template for taps: ```bash