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/26 00:26:00 UTC

[lucenenet] branch docs-poc updated: adds join, memory, misc

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 3ff97e3  adds join, memory, misc
3ff97e3 is described below

commit 3ff97e30c87d3e21375996e421d54aa55f7c4a27
Author: Shannon <sd...@gmail.com>
AuthorDate: Fri Jun 26 10:25:45 2020 +1000

    adds join, memory, misc
---
 websites/apidocs/docfx.join.json    | 76 +++++++++++++++++++++++++++++++++++++
 websites/apidocs/docfx.memory.json  | 76 +++++++++++++++++++++++++++++++++++++
 websites/apidocs/docfx.misc.json    | 76 +++++++++++++++++++++++++++++++++++++
 websites/apidocs/docfx.site.json    |  7 +++-
 websites/apidocs/docs.ps1           |  3 ++
 websites/apidocs/toc/join/toc.yml   |  3 ++
 websites/apidocs/toc/memory/toc.yml |  3 ++
 websites/apidocs/toc/misc/toc.yml   |  3 ++
 8 files changed, 245 insertions(+), 2 deletions(-)

diff --git a/websites/apidocs/docfx.join.json b/websites/apidocs/docfx.join.json
new file mode 100644
index 0000000..e713688
--- /dev/null
+++ b/websites/apidocs/docfx.join.json
@@ -0,0 +1,76 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "Lucene.Net.Join/Lucene.Net.Join.csproj"
+          ],
+          "exclude": [
+            "**/obj/**",
+            "**/bin/**"
+          ],
+          "src": "../../src"
+        }
+      ],
+      "dest": "obj/docfx/api/join",
+      "properties": {
+        "TargetFramework": "netstandard2.0"
+      }
+    }
+  ],
+  "build": {
+    "content": [       
+      {
+        "files": [
+          "**.yml",
+          "**.md"
+        ],
+        "src": "obj/docfx/api/join"
+      },   
+      {
+        "files": [
+          "toc.yml",
+          "join/toc.yml"
+        ],
+        "src": "toc"
+      }
+    ],    
+    "overwrite": [   
+      {
+        "files": [
+          "**/package.md",
+          "**/overview.md"
+        ],
+        "src": "../../src/Lucene.Net.Join",
+        "exclude": [
+          "overview.md"
+        ]
+      },     
+      {
+        "files": [
+          "apiSpec/join/**/*.md"
+        ]
+      }
+    ],
+    "xref": [
+      "_site/api/core/xrefmap.yml"
+    ],
+    "dest": "_site/api/join",
+    "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.memory.json b/websites/apidocs/docfx.memory.json
new file mode 100644
index 0000000..07908a8
--- /dev/null
+++ b/websites/apidocs/docfx.memory.json
@@ -0,0 +1,76 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "Lucene.Net.Memory/Lucene.Net.Memory.csproj"
+          ],
+          "exclude": [
+            "**/obj/**",
+            "**/bin/**"
+          ],
+          "src": "../../src"
+        }
+      ],
+      "dest": "obj/docfx/api/memory",
+      "properties": {
+        "TargetFramework": "netstandard2.0"
+      }
+    }
+  ],
+  "build": {
+    "content": [       
+      {
+        "files": [
+          "**.yml",
+          "**.md"
+        ],
+        "src": "obj/docfx/api/memory"
+      },   
+      {
+        "files": [
+          "toc.yml",
+          "memory/toc.yml"
+        ],
+        "src": "toc"
+      }
+    ],    
+    "overwrite": [   
+      {
+        "files": [
+          "**/package.md",
+          "**/overview.md"
+        ],
+        "src": "../../src/Lucene.Net.Memory",
+        "exclude": [
+          "overview.md"
+        ]
+      },     
+      {
+        "files": [
+          "apiSpec/memory/**/*.md"
+        ]
+      }
+    ],
+    "xref": [
+      "_site/api/core/xrefmap.yml"
+    ],
+    "dest": "_site/api/memory",
+    "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.misc.json b/websites/apidocs/docfx.misc.json
new file mode 100644
index 0000000..0916516
--- /dev/null
+++ b/websites/apidocs/docfx.misc.json
@@ -0,0 +1,76 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "Lucene.Net.Misc/Lucene.Net.Misc.csproj"
+          ],
+          "exclude": [
+            "**/obj/**",
+            "**/bin/**"
+          ],
+          "src": "../../src"
+        }
+      ],
+      "dest": "obj/docfx/api/misc",
+      "properties": {
+        "TargetFramework": "netstandard2.0"
+      }
+    }
+  ],
+  "build": {
+    "content": [       
+      {
+        "files": [
+          "**.yml",
+          "**.md"
+        ],
+        "src": "obj/docfx/api/misc"
+      },   
+      {
+        "files": [
+          "toc.yml",
+          "misc/toc.yml"
+        ],
+        "src": "toc"
+      }
+    ],    
+    "overwrite": [   
+      {
+        "files": [
+          "**/package.md",
+          "**/overview.md"
+        ],
+        "src": "../../src/Lucene.Net.Misc",
+        "exclude": [
+          "package.md"
+        ]
+      },     
+      {
+        "files": [
+          "apiSpec/misc/**/*.md"
+        ]
+      }
+    ],
+    "xref": [
+      "_site/api/core/xrefmap.yml"
+    ],
+    "dest": "_site/api/misc",
+    "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 7f254af..716ebb7 100644
--- a/websites/apidocs/docfx.site.json
+++ b/websites/apidocs/docfx.site.json
@@ -19,7 +19,8 @@
         "src": "../../branding"
       }
     ],
-    "xref": [            
+    "xref": [
+      "_site/api/core/xrefmap.yml",
       "_site/api/analysis-kuromoji/xrefmap.yml",
       "_site/api/analysis-morfologik/xrefmap.yml",
       "_site/api/analysis-opennlp/xrefmap.yml",
@@ -34,7 +35,9 @@
       "_site/api/grouping/xrefmap.yml",
       "_site/api/highlighter/xrefmap.yml",
       "_site/api/icu/xrefmap.yml",
-      "_site/api/core/xrefmap.yml",
+      "_site/api/join/xrefmap.yml",      
+      "_site/api/memory/xrefmap.yml",
+      "_site/api/misc/xrefmap.yml",
       "_site/api/test-framework/xrefmap.yml"      
     ],
     "dest": "_site",
diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1
index 0bc4b3d..32b2d23 100644
--- a/websites/apidocs/docs.ps1
+++ b/websites/apidocs/docs.ps1
@@ -135,6 +135,9 @@ $DocFxJsonMeta = @(
     "docfx.grouping.json",
     "docfx.highlighter.json",
     "docfx.icu.json",
+    "docfx.join.json",
+    "docfx.memory.json",
+    "docfx.misc.json",
     "docfx.test-framework.json"    
 )
 $DocFxJsonSite = Join-Path -Path $ApiDocsFolder "docfx.site.json"
diff --git a/websites/apidocs/toc/join/toc.yml b/websites/apidocs/toc/join/toc.yml
new file mode 100644
index 0000000..fc95cc4
--- /dev/null
+++ b/websites/apidocs/toc/join/toc.yml
@@ -0,0 +1,3 @@
+- name: Join
+  href: ../../obj/docfx/api/join/toc.yml
+  topicUid: Lucene.Net.Join
\ No newline at end of file
diff --git a/websites/apidocs/toc/memory/toc.yml b/websites/apidocs/toc/memory/toc.yml
new file mode 100644
index 0000000..42a3da6
--- /dev/null
+++ b/websites/apidocs/toc/memory/toc.yml
@@ -0,0 +1,3 @@
+- name: Memory
+  href: ../../obj/docfx/api/memory/toc.yml
+  topicUid: Lucene.Net.Memory
\ No newline at end of file
diff --git a/websites/apidocs/toc/misc/toc.yml b/websites/apidocs/toc/misc/toc.yml
new file mode 100644
index 0000000..f2531e7
--- /dev/null
+++ b/websites/apidocs/toc/misc/toc.yml
@@ -0,0 +1,3 @@
+- name: Misc
+  href: ../../obj/docfx/api/misc/toc.yml
+  topicUid: Lucene.Net.Misc
\ No newline at end of file