Rooba
/
spaCy
mirror of https://github.com/explosion/spaCy.git
1
1
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Support ignore marker in project document [ci skip]

This commit is contained in:
Ines Montani 2020-09-01 12:49:04 +02:00
parent a4c51f0f18
commit 70b226f69d
2 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
spacy/cli/project/document.py
View File

@ -24,8 +24,10 @@ be fetched by running [`spacy project assets`]({DOCS_URL}/api/cli#project-assets
in the project directory.""" in the project directory."""
# These markers are added to the Markdown and can be used to update the file in # These markers are added to the Markdown and can be used to update the file in
# place if it already exists. Only the auto-generated part will be replaced. # place if it already exists. Only the auto-generated part will be replaced.
MARKER_START = "<!-- AUTO-GENERATED DOCS START (do not remove) -->" MARKER_START = "<!-- SPACY PROJECT: AUTO-GENERATED DOCS START (do not remove) -->"
MARKER_END = "<!-- AUTO-GENERATED DOCS END (do not remove) -->" MARKER_END = "<!-- SPACY PROJECT: AUTO-GENERATED DOCS END (do not remove) -->"
# If this marker is used in an existing README, it's ignored and not replaced
MARKER_IGNORE = "<!-- SPACY PROJECT: IGNORE -->"
@project_cli.command("document") @project_cli.command("document")
@ -100,13 +102,16 @@ def project_document(
if output_file.exists(): if output_file.exists():
with output_file.open("r", encoding="utf8") as f: with output_file.open("r", encoding="utf8") as f:
existing = f.read() existing = f.read()
if MARKER_IGNORE in existing:
msg.warn("Found ignore marker in existing file: skipping", output_file)
return
if MARKER_START in existing and MARKER_END in existing: if MARKER_START in existing and MARKER_END in existing:
msg.info("Found existing file: only replacing auto-generated docs") msg.info("Found existing file: only replacing auto-generated docs")
before = existing.split(MARKER_START)[0] before = existing.split(MARKER_START)[0]
after = existing.split(MARKER_END)[1] after = existing.split(MARKER_END)[1]
content = f"{before}{content}{after}" content = f"{before}{content}{after}"
else: else:
msg.info("Replacing existing file") msg.warn("Replacing existing file")
with output_file.open("w") as f: with output_file.open("w") as f:
f.write(content) f.write(content)
msg.good("Saved project documentation", output_file) msg.good("Saved project documentation", output_file)

9
website/docs/usage/projects.md
View File

@ -526,6 +526,15 @@ before or after it and re-running the `project document` command will **only
update the auto-generated part**. This makes it easy to keep your documentation update the auto-generated part**. This makes it easy to keep your documentation
up to date. up to date.
<Infobox variant="warning">
Note that the contents of an existing file will be **replaced** if no existing
auto-generated docs are found. If you want spaCy to ignore a file and not update
it, you can add the comment marker `<!-- SPACY PROJECT: IGNORE -->` anywhere in
your markup.
</Infobox>
### Cloning from your own repo {#custom-repo} ### Cloning from your own repo {#custom-repo}
The [`spacy project clone`](/api/cli#project-clone) command lets you customize The [`spacy project clone`](/api/cli#project-clone) command lets you customize