Add v3 info to project docs [ci skip]

This commit is contained in:
Ines Montani 2020-09-01 12:36:21 +02:00
parent ef9005273b
commit a4c51f0f18
1 changed files with 4 additions and 0 deletions

View File

@ -6,6 +6,9 @@ from .._util import project_cli, Arg, Opt, PROJECT_FILE, load_project_config
DOCS_URL = "https://nightly.spacy.io" 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 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 project, as well as the available commands and workflows. For details, see the
[spaCy projects documentation]({DOCS_URL}/usage/projects).""" [spaCy projects documentation]({DOCS_URL}/usage/projects)."""
@ -52,6 +55,7 @@ def project_document(
title = config.get("title") title = config.get("title")
description = config.get("description") description = config.get("description")
md.add(md.title(1, f"spaCy Project{f': {title}' if title else ''}", "🪐")) md.add(md.title(1, f"spaCy Project{f': {title}' if title else ''}", "🪐"))
md.add(INTRO)
if description: if description:
md.add(description) md.add(description)
md.add(md.title(2, PROJECT_FILE, "📋")) md.add(md.title(2, PROJECT_FILE, "📋"))