You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucenenet.apache.org by sh...@apache.org on 2020/06/25 23:59:51 UTC
[lucenenet] branch docs-poc updated: Ensures all overwrite files
package/overview are included in builds, adds highlighter and icu builds
This is an automated email from the ASF dual-hosted git repository.
shazwazza pushed a commit to branch docs-poc
in repository https://gitbox.apache.org/repos/asf/lucenenet.git
The following commit(s) were added to refs/heads/docs-poc by this push:
new 07ca74e Ensures all overwrite files package/overview are included in builds, adds highlighter and icu builds
07ca74e is described below
commit 07ca74ea333c0cad802835ea0581b84f56a626cc
Author: Shannon <sd...@gmail.com>
AuthorDate: Fri Jun 26 09:59:34 2020 +1000
Ensures all overwrite files package/overview are included in builds, adds highlighter and icu builds
---
websites/apidocs/docfx.analysis-common.json | 12 +++++++++-
websites/apidocs/docfx.analysis-kuromoji.json | 12 ++++++----
websites/apidocs/docfx.analysis-morfologik.json | 12 ++++++----
websites/apidocs/docfx.analysis-opennlp.json | 12 ++++++----
websites/apidocs/docfx.analysis-phonetic.json | 10 +++++---
websites/apidocs/docfx.analysis-smartcn.json | 10 +++++---
websites/apidocs/docfx.analysis-stempel.json | 10 +++++---
websites/apidocs/docfx.benchmark.json | 10 +++++---
websites/apidocs/docfx.classification.json | 10 +++++---
websites/apidocs/docfx.codecs.json | 12 +++++++++-
websites/apidocs/docfx.core.json | 15 +++++++++++-
websites/apidocs/docfx.expressions.json | 12 +++++++++-
websites/apidocs/docfx.facet.json | 12 +++++++++-
websites/apidocs/docfx.grouping.json | 12 +++++++++-
...nalysis-smartcn.json => docfx.highlighter.json} | 26 +++++++++++---------
...{docfx.analysis-smartcn.json => docfx.icu.json} | 28 ++++++++++++----------
websites/apidocs/docfx.site.json | 2 ++
websites/apidocs/toc/highlighter/toc.yml | 3 +++
websites/apidocs/toc/icu/toc.yml | 3 +++
19 files changed, 167 insertions(+), 56 deletions(-)
diff --git a/websites/apidocs/docfx.analysis-common.json b/websites/apidocs/docfx.analysis-common.json
index 2433885..674f5a3 100644
--- a/websites/apidocs/docfx.analysis-common.json
+++ b/websites/apidocs/docfx.analysis-common.json
@@ -42,7 +42,17 @@
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
+ {
+ "files": [
+ "**/package.md",
+ "**/overview.md"
+ ],
+ "src": "../../src/Lucene.Net.Analysis.Common",
+ "exclude": [
+ "overview.md"
+ ]
+ },
{
"files": [
"apiSpec/analysis-common/**/*.md"
diff --git a/websites/apidocs/docfx.analysis-kuromoji.json b/websites/apidocs/docfx.analysis-kuromoji.json
index ddd84e0..0274960 100644
--- a/websites/apidocs/docfx.analysis-kuromoji.json
+++ b/websites/apidocs/docfx.analysis-kuromoji.json
@@ -36,13 +36,17 @@
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
{
"files": [
- "overview.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Analysis.Kuromoji"
- },
+ "src": "../../src/Lucene.Net.Analysis.Kuromoji",
+ "exclude": [
+ "package.md"
+ ]
+ },
{
"files": [
"apiSpec/analysis-kuromoji/**/*.md"
diff --git a/websites/apidocs/docfx.analysis-morfologik.json b/websites/apidocs/docfx.analysis-morfologik.json
index b990d6c..8a34b5f 100644
--- a/websites/apidocs/docfx.analysis-morfologik.json
+++ b/websites/apidocs/docfx.analysis-morfologik.json
@@ -36,13 +36,17 @@
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
{
"files": [
- "overview.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Analysis.Morfologik"
- },
+ "src": "../../src/Lucene.Net.Analysis.Morfologik",
+ "exclude": [
+ "package.md"
+ ]
+ },
{
"files": [
"apiSpec/analysis-morfologik/**/*.md"
diff --git a/websites/apidocs/docfx.analysis-opennlp.json b/websites/apidocs/docfx.analysis-opennlp.json
index ab053ae..b266a1c 100644
--- a/websites/apidocs/docfx.analysis-opennlp.json
+++ b/websites/apidocs/docfx.analysis-opennlp.json
@@ -36,13 +36,17 @@
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
{
"files": [
- "overview.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Analysis.OpenNLP"
- },
+ "src": "../../src/Lucene.Net.Analysis.OpenNLP",
+ "exclude": [
+ "package.md"
+ ]
+ },
{
"files": [
"apiSpec/analysis-opennlp/**/*.md"
diff --git a/websites/apidocs/docfx.analysis-phonetic.json b/websites/apidocs/docfx.analysis-phonetic.json
index db9a84e..7957aa9 100644
--- a/websites/apidocs/docfx.analysis-phonetic.json
+++ b/websites/apidocs/docfx.analysis-phonetic.json
@@ -39,10 +39,14 @@
"overwrite": [
{
"files": [
- "overview.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Analysis.Phonetic"
- },
+ "src": "../../src/Lucene.Net.Analysis.Phonetic",
+ "exclude": [
+ "package.md"
+ ]
+ },
{
"files": [
"apiSpec/analysis-phonetic/**/*.md"
diff --git a/websites/apidocs/docfx.analysis-smartcn.json b/websites/apidocs/docfx.analysis-smartcn.json
index 2c0dd47..c1a900a 100644
--- a/websites/apidocs/docfx.analysis-smartcn.json
+++ b/websites/apidocs/docfx.analysis-smartcn.json
@@ -39,10 +39,14 @@
"overwrite": [
{
"files": [
- "package.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Analysis.SmartCn"
- },
+ "src": "../../src/Lucene.Net.Analysis.SmartCn",
+ "exclude": [
+ "overview.md"
+ ]
+ },
{
"files": [
"apiSpec/analysis-smartcn/**/*.md"
diff --git a/websites/apidocs/docfx.analysis-stempel.json b/websites/apidocs/docfx.analysis-stempel.json
index 7eb552c..62e723d 100644
--- a/websites/apidocs/docfx.analysis-stempel.json
+++ b/websites/apidocs/docfx.analysis-stempel.json
@@ -39,10 +39,14 @@
"overwrite": [
{
"files": [
- "overview.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Analysis.Stempel"
- },
+ "src": "../../src/Lucene.Net.Analysis.Stempel",
+ "exclude": [
+ "package.md"
+ ]
+ },
{
"files": [
"apiSpec/analysis-stempel/**/*.md"
diff --git a/websites/apidocs/docfx.benchmark.json b/websites/apidocs/docfx.benchmark.json
index 275e155..c201e9d 100644
--- a/websites/apidocs/docfx.benchmark.json
+++ b/websites/apidocs/docfx.benchmark.json
@@ -39,10 +39,14 @@
"overwrite": [
{
"files": [
- "package.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Benchmark"
- },
+ "src": "../../src/Lucene.Net.Benchmark",
+ "exclude": [
+ "overview.md"
+ ]
+ },
{
"files": [
"apiSpec/benchmark/**/*.md"
diff --git a/websites/apidocs/docfx.classification.json b/websites/apidocs/docfx.classification.json
index c2f6709..0494da0 100644
--- a/websites/apidocs/docfx.classification.json
+++ b/websites/apidocs/docfx.classification.json
@@ -39,10 +39,14 @@
"overwrite": [
{
"files": [
- "package.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Classification"
- },
+ "src": "../../src/Lucene.Net.Classification",
+ "exclude": [
+ "overview.md"
+ ]
+ },
{
"files": [
"apiSpec/classification/**/*.md"
diff --git a/websites/apidocs/docfx.codecs.json b/websites/apidocs/docfx.codecs.json
index c1898d9..3c530bb 100644
--- a/websites/apidocs/docfx.codecs.json
+++ b/websites/apidocs/docfx.codecs.json
@@ -42,7 +42,17 @@
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
+ {
+ "files": [
+ "**/package.md",
+ "**/overview.md"
+ ],
+ "src": "../../src/Lucene.Net.Codecs",
+ "exclude": [
+ "overview.md"
+ ]
+ },
{
"files": [
"apiSpec/codecs/**/*.md"
diff --git a/websites/apidocs/docfx.core.json b/websites/apidocs/docfx.core.json
index f6d1b5b..7c4b6da 100644
--- a/websites/apidocs/docfx.core.json
+++ b/websites/apidocs/docfx.core.json
@@ -42,13 +42,26 @@
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
+ {
+ "files": [
+ "**/package.md",
+ "**/overview.md"
+ ],
+ "src": "../../src/Lucene.Net",
+ "exclude": [
+ "overview.md"
+ ]
+ },
{
"files": [
"apiSpec/core/**/*.md"
]
}
],
+ "xref": [
+ "_site/api/codecs/xrefmap.yml"
+ ],
"dest": "_site/api/core",
"globalMetadataFiles": [
"docfx.global.json",
diff --git a/websites/apidocs/docfx.expressions.json b/websites/apidocs/docfx.expressions.json
index 8889e96..a505676 100644
--- a/websites/apidocs/docfx.expressions.json
+++ b/websites/apidocs/docfx.expressions.json
@@ -42,7 +42,17 @@
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
+ {
+ "files": [
+ "**/package.md",
+ "**/overview.md"
+ ],
+ "src": "../../src/Lucene.Net.Expressions",
+ "exclude": [
+ "overview.md"
+ ]
+ },
{
"files": [
"apiSpec/expressions/**/*.md"
diff --git a/websites/apidocs/docfx.facet.json b/websites/apidocs/docfx.facet.json
index 2c297b3..c1f99d9 100644
--- a/websites/apidocs/docfx.facet.json
+++ b/websites/apidocs/docfx.facet.json
@@ -42,7 +42,17 @@
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
+ {
+ "files": [
+ "**/package.md",
+ "**/overview.md"
+ ],
+ "src": "../../src/Lucene.Net.Facet",
+ "exclude": [
+ "package.md"
+ ]
+ },
{
"files": [
"apiSpec/facet/**/*.md"
diff --git a/websites/apidocs/docfx.grouping.json b/websites/apidocs/docfx.grouping.json
index 9251a0c..97e2586 100644
--- a/websites/apidocs/docfx.grouping.json
+++ b/websites/apidocs/docfx.grouping.json
@@ -42,7 +42,17 @@
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
+ {
+ "files": [
+ "**/package.md",
+ "**/overview.md"
+ ],
+ "src": "../../src/Lucene.Net.Grouping",
+ "exclude": [
+ "package.md"
+ ]
+ },
{
"files": [
"apiSpec/grouping/**/*.md"
diff --git a/websites/apidocs/docfx.analysis-smartcn.json b/websites/apidocs/docfx.highlighter.json
similarity index 70%
copy from websites/apidocs/docfx.analysis-smartcn.json
copy to websites/apidocs/docfx.highlighter.json
index 2c0dd47..d6e022e 100644
--- a/websites/apidocs/docfx.analysis-smartcn.json
+++ b/websites/apidocs/docfx.highlighter.json
@@ -4,7 +4,7 @@
"src": [
{
"files": [
- "Lucene.Net.Analysis.SmartCn/Lucene.Net.Analysis.SmartCn.csproj"
+ "Lucene.Net.Highlighter/Lucene.Net.Highlighter.csproj"
],
"exclude": [
"**/obj/**",
@@ -13,46 +13,50 @@
"src": "../../src"
}
],
- "dest": "obj/docfx/api/analysis-smartcn",
+ "dest": "obj/docfx/api/Highlighter",
"properties": {
"TargetFramework": "netstandard2.0"
}
}
],
"build": {
- "content": [
+ "content": [
{
"files": [
"**.yml",
"**.md"
],
- "src": "obj/docfx/api/analysis-smartcn"
+ "src": "obj/docfx/api/highlighter"
},
{
"files": [
"toc.yml",
- "analysis-smartcn/toc.yml"
+ "highlighter/toc.yml"
],
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
{
"files": [
- "package.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Analysis.SmartCn"
- },
+ "src": "../../src/Lucene.Net.Highlighter",
+ "exclude": [
+ "package.md"
+ ]
+ },
{
"files": [
- "apiSpec/analysis-smartcn/**/*.md"
+ "apiSpec/highlighter/**/*.md"
]
}
],
"xref": [
"_site/api/core/xrefmap.yml"
],
- "dest": "_site/api/analysis-smartcn",
+ "dest": "_site/api/highlighter",
"globalMetadataFiles": [
"docfx.global.json",
"docfx.global.subsite.json"
diff --git a/websites/apidocs/docfx.analysis-smartcn.json b/websites/apidocs/docfx.icu.json
similarity index 70%
copy from websites/apidocs/docfx.analysis-smartcn.json
copy to websites/apidocs/docfx.icu.json
index 2c0dd47..89c4691 100644
--- a/websites/apidocs/docfx.analysis-smartcn.json
+++ b/websites/apidocs/docfx.icu.json
@@ -4,55 +4,59 @@
"src": [
{
"files": [
- "Lucene.Net.Analysis.SmartCn/Lucene.Net.Analysis.SmartCn.csproj"
+ "Lucene.Net.ICU/Lucene.Net.ICU.csproj"
],
"exclude": [
"**/obj/**",
"**/bin/**"
],
- "src": "../../src"
+ "src": "../../src/dotnet"
}
],
- "dest": "obj/docfx/api/analysis-smartcn",
+ "dest": "obj/docfx/api/icu",
"properties": {
"TargetFramework": "netstandard2.0"
}
}
],
"build": {
- "content": [
+ "content": [
{
"files": [
"**.yml",
"**.md"
],
- "src": "obj/docfx/api/analysis-smartcn"
+ "src": "obj/docfx/api/icu"
},
{
"files": [
"toc.yml",
- "analysis-smartcn/toc.yml"
+ "icu/toc.yml"
],
"src": "toc"
}
],
- "overwrite": [
+ "overwrite": [
{
"files": [
- "package.md"
+ "**/package.md",
+ "**/overview.md"
],
- "src": "../../src/Lucene.Net.Analysis.SmartCn"
- },
+ "src": "../../src/Lucene.Net.Analysis.ICU",
+ "exclude": [
+ "package.md"
+ ]
+ },
{
"files": [
- "apiSpec/analysis-smartcn/**/*.md"
+ "apiSpec/icu/**/*.md"
]
}
],
"xref": [
"_site/api/core/xrefmap.yml"
],
- "dest": "_site/api/analysis-smartcn",
+ "dest": "_site/api/icu",
"globalMetadataFiles": [
"docfx.global.json",
"docfx.global.subsite.json"
diff --git a/websites/apidocs/docfx.site.json b/websites/apidocs/docfx.site.json
index fbe4960..7f254af 100644
--- a/websites/apidocs/docfx.site.json
+++ b/websites/apidocs/docfx.site.json
@@ -32,6 +32,8 @@
"_site/api/codecs/xrefmap.yml",
"_site/api/facet/xrefmap.yml",
"_site/api/grouping/xrefmap.yml",
+ "_site/api/highlighter/xrefmap.yml",
+ "_site/api/icu/xrefmap.yml",
"_site/api/core/xrefmap.yml",
"_site/api/test-framework/xrefmap.yml"
],
diff --git a/websites/apidocs/toc/highlighter/toc.yml b/websites/apidocs/toc/highlighter/toc.yml
new file mode 100644
index 0000000..cfef8fa
--- /dev/null
+++ b/websites/apidocs/toc/highlighter/toc.yml
@@ -0,0 +1,3 @@
+- name: Highlighter
+ href: ../../obj/docfx/api/highlighter/toc.yml
+ topicUid: Lucene.Net.Highlighter
\ No newline at end of file
diff --git a/websites/apidocs/toc/icu/toc.yml b/websites/apidocs/toc/icu/toc.yml
new file mode 100644
index 0000000..b2ce761
--- /dev/null
+++ b/websites/apidocs/toc/icu/toc.yml
@@ -0,0 +1,3 @@
+- name: ICU
+ href: ../../obj/docfx/api/icu/toc.yml
+ topicUid: Lucene.Net.ICU
\ No newline at end of file