Move CLI docs to own page

This commit is contained in:
ines 2017-10-30 19:39:26 +01:00
parent ec657c1ddc
commit 57534253e6
4 changed files with 17 additions and 12 deletions

View File

@ -41,9 +41,6 @@
- var comps = path.split('#'); - var comps = path.split('#');
- return "top-level#" + comps[0] + '.' + comps[1]; - return "top-level#" + comps[0] + '.' + comps[1];
- } - }
- else if (path.startsWith('cli#')) {
- return "top-level#" + path.split('#')[1];
- }
- return path; - return path;
- } - }

View File

@ -3,8 +3,10 @@
"Overview": { "Overview": {
"Architecture": "./", "Architecture": "./",
"Annotation Specs": "annotation", "Annotation Specs": "annotation",
"Command Line": "cli",
"Functions": "top-level" "Functions": "top-level"
}, },
"Containers": { "Containers": {
"Doc": "doc", "Doc": "doc",
"Token": "token", "Token": "token",
@ -45,14 +47,19 @@
} }
}, },
"cli": {
"title": "Command Line Interface",
"teaser": "Download, train and package models, and debug spaCy.",
"source": "spacy/cli"
},
"top-level": { "top-level": {
"title": "Top-level Functions", "title": "Top-level Functions",
"menu": { "menu": {
"spacy": "spacy", "spacy": "spacy",
"displacy": "displacy", "displacy": "displacy",
"Utility Functions": "util", "Utility Functions": "util",
"Compatibility": "compat", "Compatibility": "compat"
"Command Line": "cli"
} }
}, },

View File

@ -1,4 +1,6 @@
//- 💫 DOCS > API > TOP-LEVEL > COMMAND LINE INTERFACE //- 💫 DOCS > API > COMMAND LINE INTERFACE
include ../_includes/_mixins
p p
| As of v1.7.0, spaCy comes with new command line helpers to download and | As of v1.7.0, spaCy comes with new command line helpers to download and
@ -434,7 +436,8 @@ p
+tag-new(2) +tag-new(2)
p p
| Compile a vocabulary from a #[+a("#") lexicon JSONL] file and optional | Compile a vocabulary from a
| #[+a("/api/annotation#vocab-jsonl") lexicon JSONL] file and optional
| word vectors. Will save out a valid spaCy model that you can load via | word vectors. Will save out a valid spaCy model that you can load via
| #[+api("spacy#load") #[code spacy.load]] or package using the | #[+api("spacy#load") #[code spacy.load]] or package using the
| #[+api("cli#package") #[code package]] command. | #[+api("cli#package") #[code package]] command.
@ -459,7 +462,9 @@ p
+row +row
+cell #[code lexemes_loc] +cell #[code lexemes_loc]
+cell positional +cell positional
+cell Location of lexical data in spaCy's #[+a("#") JSONL format]. +cell
| Location of lexical data in spaCy's
| #[+a("/api/annotation#vocab-jsonl") JSONL format].
+row +row
+cell #[code vectors_loc] +cell #[code vectors_loc]

View File

@ -18,7 +18,3 @@ include ../_includes/_mixins
+section("compat") +section("compat")
+h(2, "compat", "spacy/compaty.py") Compatibility functions +h(2, "compat", "spacy/compaty.py") Compatibility functions
include _top-level/_compat include _top-level/_compat
+section("cli", "spacy/cli")
+h(2, "cli") Command line
include _top-level/_cli