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/23 06:25:58 UTC
[lucenenet] branch docs-poc updated: adds expressions and facets
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 d5a78a8 adds expressions and facets
d5a78a8 is described below
commit d5a78a883b3e6002d97bc0d23035fc264ceb711c
Author: Shannon <sd...@gmail.com>
AuthorDate: Tue Jun 23 16:25:44 2020 +1000
adds expressions and facets
---
websites/apidocs/docfx.expressions.json | 72 ++++++++++++++++++++++++++++++++
websites/apidocs/docfx.facet.json | 72 ++++++++++++++++++++++++++++++++
websites/apidocs/docfx.site.json | 1 +
websites/apidocs/docs.ps1 | 2 +
websites/apidocs/index.md | 44 +++++++++----------
websites/apidocs/toc/expressions/toc.yml | 3 ++
websites/apidocs/toc/facet/toc.yml | 3 ++
7 files changed, 175 insertions(+), 22 deletions(-)
diff --git a/websites/apidocs/docfx.expressions.json b/websites/apidocs/docfx.expressions.json
new file mode 100644
index 0000000..8889e96
--- /dev/null
+++ b/websites/apidocs/docfx.expressions.json
@@ -0,0 +1,72 @@
+{
+ "metadata": [
+ {
+ "src": [
+ {
+ "files": [
+ "Lucene.Net.Expressions/Lucene.Net.Expressions.csproj"
+ ],
+ "exclude": [
+ "**/obj/**",
+ "**/bin/**"
+ ],
+ "src": "../../src"
+ }
+ ],
+ "dest": "obj/docfx/api/expressions",
+ "properties": {
+ "TargetFramework": "netstandard2.0"
+ }
+ }
+ ],
+ "build": {
+ "content": [
+ {
+ "files": [
+ "overview.md"
+ ],
+ "src": "../../src/Lucene.Net.Expressions"
+ },
+ {
+ "files": [
+ "**.yml",
+ "**.md"
+ ],
+ "src": "obj/docfx/api/expressions"
+ },
+ {
+ "files": [
+ "toc.yml",
+ "expressions/toc.yml"
+ ],
+ "src": "toc"
+ }
+ ],
+ "overwrite": [
+ {
+ "files": [
+ "apiSpec/expressions/**/*.md"
+ ]
+ }
+ ],
+ "xref": [
+ "_site/api/core/xrefmap.yml"
+ ],
+ "dest": "_site/api/expressions",
+ "globalMetadataFiles": [
+ "docfx.global.json",
+ "docfx.global.subsite.json"
+ ],
+ "template": [
+ "Templates/DefaultTemplateNoAssets",
+ "Templates/LuceneTemplate",
+ "Templates/LuceneApiDocs"
+ ],
+ "postProcessors": [],
+ "markdownEngineName": "dfm",
+ "noLangKeyword": false,
+ "keepFileLink": false,
+ "cleanupCacheHistory": false,
+ "disableGitFeatures": false
+ }
+}
\ No newline at end of file
diff --git a/websites/apidocs/docfx.facet.json b/websites/apidocs/docfx.facet.json
new file mode 100644
index 0000000..2c297b3
--- /dev/null
+++ b/websites/apidocs/docfx.facet.json
@@ -0,0 +1,72 @@
+{
+ "metadata": [
+ {
+ "src": [
+ {
+ "files": [
+ "Lucene.Net.Facet/Lucene.Net.Facet.csproj"
+ ],
+ "exclude": [
+ "**/obj/**",
+ "**/bin/**"
+ ],
+ "src": "../../src"
+ }
+ ],
+ "dest": "obj/docfx/api/Facet",
+ "properties": {
+ "TargetFramework": "netstandard2.0"
+ }
+ }
+ ],
+ "build": {
+ "content": [
+ {
+ "files": [
+ "package.md"
+ ],
+ "src": "../../src/Lucene.Net.Facet"
+ },
+ {
+ "files": [
+ "**.yml",
+ "**.md"
+ ],
+ "src": "obj/docfx/api/facet"
+ },
+ {
+ "files": [
+ "toc.yml",
+ "facet/toc.yml"
+ ],
+ "src": "toc"
+ }
+ ],
+ "overwrite": [
+ {
+ "files": [
+ "apiSpec/facet/**/*.md"
+ ]
+ }
+ ],
+ "xref": [
+ "_site/api/core/xrefmap.yml"
+ ],
+ "dest": "_site/api/facet",
+ "globalMetadataFiles": [
+ "docfx.global.json",
+ "docfx.global.subsite.json"
+ ],
+ "template": [
+ "Templates/DefaultTemplateNoAssets",
+ "Templates/LuceneTemplate",
+ "Templates/LuceneApiDocs"
+ ],
+ "postProcessors": [],
+ "markdownEngineName": "dfm",
+ "noLangKeyword": false,
+ "keepFileLink": false,
+ "cleanupCacheHistory": false,
+ "disableGitFeatures": false
+ }
+}
\ No newline at end of file
diff --git a/websites/apidocs/docfx.site.json b/websites/apidocs/docfx.site.json
index 12e3746..053460a 100644
--- a/websites/apidocs/docfx.site.json
+++ b/websites/apidocs/docfx.site.json
@@ -30,6 +30,7 @@
"_site/api/benchmark/xrefmap.yml",
"_site/api/classification/xrefmap.yml",
"_site/api/codecs/xrefmap.yml",
+ "_site/api/facet/xrefmap.yml",
"_site/api/core/xrefmap.yml",
"_site/api/test-framework/xrefmap.yml"
],
diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1
index 1b9d22b..1c57393 100644
--- a/websites/apidocs/docs.ps1
+++ b/websites/apidocs/docs.ps1
@@ -130,6 +130,8 @@ $DocFxJsonMeta = @(
"docfx.benchmark.json",
"docfx.classification.json",
"docfx.codecs.json",
+ "docfx.expressions.json",
+ "docfx.facet.json",
"docfx.test-framework.json"
)
$DocFxJsonSite = Join-Path -Path $ApiDocsFolder "docfx.site.json"
diff --git a/websites/apidocs/index.md b/websites/apidocs/index.md
index df91de5..2426869 100644
--- a/websites/apidocs/index.md
+++ b/websites/apidocs/index.md
@@ -39,32 +39,32 @@ on some of the conceptual or inner details of Lucene:
## Libraries
-* [Lucene.Net](xref:Lucene.Net) - Core library
-* [Lucene.Net.Analysis.Common](xref:Lucene.Net.Analysis.Common) - Analyzers for indexing content in different languages and domains
+* <xref:Lucene.Net> - Core library
+* <xref:Lucene.Net.Analysis.Common> - Analyzers for indexing content in different languages and domains
* [Lucene.Net.Analysis.Kuromoji](xref:Lucene.Net.Analysis.Ja) - Japanese Morphological Analyzer
-* [Lucene.Net.Analysis.Morfologik](xref:Lucene.Net.Analysis.Morfologik) - Analyzer for dictionary stemming, built-in Polish dictionary
-* [Lucene.Net.Analysis.OpenNLP](xref:Lucene.Net.Analysis.OpenNlp) - OpenNLP Library Integration
-* [Lucene.Net.Analysis.Phonetic](xref:Lucene.Net.Analysis.Phonetic) - Analyzer for indexing phonetic signatures (for sounds-alike search)
+* <xref:Lucene.Net.Analysis.Morfologik> - Analyzer for dictionary stemming, built-in Polish dictionary
+* <xref:Lucene.Net.Analysis.OpenNlp> - OpenNLP Library Integration
+* <xref:Lucene.Net.Analysis.Phonetic> - Analyzer for indexing phonetic signatures (for sounds-alike search)
* [Lucene.Net.Analysis.SmartCn](xref:Lucene.Net.Analysis.Cn.Smart) - Analyzer for indexing Chinese
-* [Lucene.Net.Analysis.Stempel](xref:Lucene.Net.Analysis.Stempel) - Analyzer for indexing Polish
+* <xref:Lucene.Net.Analysis.Stempel> - Analyzer for indexing Polish
* [Lucene.Net.Benchmark](xref:Lucene.Net.Benchmarks) - System for benchmarking Lucene
-* [Lucene.Net.Classification](xref:Lucene.Net.Classification) - Classification module for Lucene
-* [Lucene.Net.Codecs](xref:Lucene.Net.Codecs) - Lucene codecs and postings formats
-* [Lucene.Net.Expressions](xref:Lucene.Net.Expressions) - Dynamically computed values to sort/facet/search on based on a pluggable grammar
-* [Lucene.Net.Facet](xref:Lucene.Net.Facet) - Faceted indexing and search capabilities
-* [Lucene.Net.Grouping](xref:Lucene.Net.Grouping) - Collectors for grouping search results
-* [Lucene.Net.Highlighter](xref:Lucene.Net.Search.Highlight) - Highlights search keywords in results
-* [Lucene.Net.ICU](xref:Lucene.Net.Analysis.Icu) - Specialized ICU (International Components for Unicode) Analyzers and Highlighters
-* [Lucene.Net.Join](xref:Lucene.Net.Join) - Index-time and Query-time joins for normalized content
+* <xref:Lucene.Net.Classification> - Classification module for Lucene
+* <xref:Lucene.Net.Codecs> - Lucene codecs and postings formats
+* <xref:Lucene.Net.Expressions> - Dynamically computed values to sort/facet/search on based on a pluggable grammar
+* <xref:Lucene.Net.Facet> - Faceted indexing and search capabilities
+* <xref:Lucene.Net.Grouping> - Collectors for grouping search results
+* <xref:Lucene.Net.Search.Highlight> - Highlights search keywords in results
+* <xref:Lucene.Net.Analysis.Icu> - Specialized ICU (International Components for Unicode) Analyzers and Highlighters
+* <xref:Lucene.Net.Join> - Index-time and Query-time joins for normalized content
* [Lucene.Net.Memory](xref:Lucene.Net.Index.Memory) - Single-document in-memory index implementation
-* [Lucene.Net.Misc](xref:Lucene.Net.Misc) - Index tools and other miscellaneous code
-* [Lucene.Net.Queries](xref:Lucene.Net.Queries) - Filters and Queries that add to core Lucene
-* [Lucene.Net.QueryParser](xref:Lucene.Net.QueryParser) - Text to Query parsers and parsing framework
-* [Lucene.Net.Replicator](xref:Lucene.Net.Replicator) Files replication utility
-* [Lucene.Net.Sandbox](xref:Lucene.Net.Sandbox) - Various third party contributions and new ideas
-* [Lucene.Net.Spatial](xref:Lucene.Net.Spatial) - Geospatial search
-* [Lucene.Net.Suggest](xref:Lucene.Net.Suggest) - Auto-suggest and Spell-checking support
-* [Lucene.Net.TestFramework](xref:Lucene.Net.TestFramework) - Framework for testing Lucene-based applications
+* <xref:Lucene.Net.Misc> - Index tools and other miscellaneous code
+* <xref:Lucene.Net.Queries> - Filters and Queries that add to core Lucene
+* <xref:Lucene.Net.QueryParser> - Text to Query parsers and parsing framework
+* <xref:Lucene.Net.Replicator> Files replication utility
+* <xref:Lucene.Net.Sandbox> - Various third party contributions and new ideas
+* <xref:Lucene.Net.Spatial> - Geospatial search
+* <xref:Lucene.Net.Suggest> - Auto-suggest and Spell-checking support
+* <xref:Lucene.Net.TestFramework> - Framework for testing Lucene-based applications
### Tools
diff --git a/websites/apidocs/toc/expressions/toc.yml b/websites/apidocs/toc/expressions/toc.yml
new file mode 100644
index 0000000..9e0ffa1
--- /dev/null
+++ b/websites/apidocs/toc/expressions/toc.yml
@@ -0,0 +1,3 @@
+- name: Expressions
+ href: ../../obj/docfx/api/expressions/toc.yml
+ topicUid: Lucene.Net.Expressions
\ No newline at end of file
diff --git a/websites/apidocs/toc/facet/toc.yml b/websites/apidocs/toc/facet/toc.yml
new file mode 100644
index 0000000..68a95f0
--- /dev/null
+++ b/websites/apidocs/toc/facet/toc.yml
@@ -0,0 +1,3 @@
+- name: Facet
+ href: ../../obj/docfx/api/facet/toc.yml
+ topicUid: Lucene.Net.Facet
\ No newline at end of file