From a4c51f0f18e0eea6d994b53de9571e07fa077ded Mon Sep 17 00:00:00 2001 From: Ines Montani Date: Tue, 1 Sep 2020 12:36:21 +0200 Subject: [PATCH] Add v3 info to project docs [ci skip] --- spacy/cli/project/document.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/spacy/cli/project/document.py b/spacy/cli/project/document.py index ffa77b2d5..30cb2af25 100644 --- a/spacy/cli/project/document.py +++ b/spacy/cli/project/document.py @@ -6,6 +6,9 @@ from .._util import project_cli, Arg, Opt, PROJECT_FILE, load_project_config DOCS_URL = "https://nightly.spacy.io" +INTRO = f"""> ⚠️ This project template uses the new [**spaCy v3.0**]({DOCS_URL}), which +> is currently available as a nightly pre-release. You can install it from pip as `spacy-nightly`: +> `pip install spacy-nightly`. Make sure to use a fresh virtual environment.""" INTRO_PROJECT = f"""The [`{PROJECT_FILE}`]({PROJECT_FILE}) defines the data assets required by the project, as well as the available commands and workflows. For details, see the [spaCy projects documentation]({DOCS_URL}/usage/projects).""" @@ -52,6 +55,7 @@ def project_document( title = config.get("title") description = config.get("description") md.add(md.title(1, f"spaCy Project{f': {title}' if title else ''}", "🪐")) + md.add(INTRO) if description: md.add(description) md.add(md.title(2, PROJECT_FILE, "📋"))