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
commit 70b43f67170f2e9036c0a4efad3631a416ffc076 Author: Shannon <[email protected]> AuthorDate: Thu Jun 18 14:32:15 2020 +1000 Morfologik docs now building --- websites/apidocs/docfx.analysis-kuromoji.json | 66 ++++++++++++++++++++++ websites/apidocs/docfx.analysis-morfologik.json | 72 ++++++++++++++++++++++++ websites/apidocs/docfx.site.json | 4 +- websites/apidocs/docs.ps1 | 12 +++- websites/apidocs/toc/analysis-kuromoji/toc.yml | 3 + websites/apidocs/toc/analysis-morfologik/toc.yml | 3 + 6 files changed, 157 insertions(+), 3 deletions(-) diff --git a/websites/apidocs/docfx.analysis-kuromoji.json b/websites/apidocs/docfx.analysis-kuromoji.json new file mode 100644 index 0000000..c6ec2b6 --- /dev/null +++ b/websites/apidocs/docfx.analysis-kuromoji.json @@ -0,0 +1,66 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "Lucene.Net.Analysis.Kuromoji/Lucene.Net.Analysis.Kuromoji.csproj" + ], + "exclude": [ + "**/obj/**", + "**/bin/**" + ], + "src": "../../src" + } + ], + "dest": "obj/docfx/api/analysis-kuromoji", + "properties": { + "TargetFramework": "netstandard2.0" + } + } + ], + "build": { + "content": [ + { + "files": [ + "**.yml", + "**.md" + ], + "src": "obj/docfx/api/analysis-kuromoji" + }, + { + "files": [ + "toc.yml", + "analysis-kuromoji/toc.yml" + ], + "src": "toc" + } + ], + "overwrite": [ + { + "files": [ + "apiSpec/analysis-kuromoji/**/*.md" + ] + } + ], + "xref": [ + "_site/api/core/xrefmap.yml" + ], + "dest": "_site/api/analysis-kuromoji", + "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.analysis-morfologik.json b/websites/apidocs/docfx.analysis-morfologik.json new file mode 100644 index 0000000..b990d6c --- /dev/null +++ b/websites/apidocs/docfx.analysis-morfologik.json @@ -0,0 +1,72 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "Lucene.Net.Analysis.Morfologik/Lucene.Net.Analysis.Morfologik.csproj" + ], + "exclude": [ + "**/obj/**", + "**/bin/**" + ], + "src": "../../src" + } + ], + "dest": "obj/docfx/api/analysis-morfologik", + "properties": { + "TargetFramework": "netstandard2.0" + } + } + ], + "build": { + "content": [ + { + "files": [ + "**.yml", + "**.md" + ], + "src": "obj/docfx/api/analysis-morfologik" + }, + { + "files": [ + "toc.yml", + "analysis-morfologik/toc.yml" + ], + "src": "toc" + } + ], + "overwrite": [ + { + "files": [ + "overview.md" + ], + "src": "../../src/Lucene.Net.Analysis.Morfologik" + }, + { + "files": [ + "apiSpec/analysis-morfologik/**/*.md" + ] + } + ], + "xref": [ + "_site/api/core/xrefmap.yml" + ], + "dest": "_site/api/analysis-morfologik", + "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 e2c4b24..889fb02 100644 --- a/websites/apidocs/docfx.site.json +++ b/websites/apidocs/docfx.site.json @@ -22,7 +22,9 @@ "xref": [ "_site/api/core/xrefmap.yml", "_site/api/analysis-common/xrefmap.yml", - "_site/api/test-framework/xrefmap.yml" + "_site/api/analysis-kuromoji/xrefmap.yml", + "_site/api/analysis-morfologik/xrefmap.yml", + "_site/api/test-framework/xrefmap.yml" ], "dest": "_site", "globalMetadataFiles": ["docfx.global.json"], diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1 index 77dc91a..9624d29 100644 --- a/websites/apidocs/docs.ps1 +++ b/websites/apidocs/docs.ps1 @@ -120,7 +120,10 @@ $DocFxJsonContent | ConvertTo-Json -depth 100 | Set-Content $DocFxGlobalJson $DocFxJsonMeta = @( "docfx.core.json", - "docfx.test-framework.json" + "docfx.analysis-common.json", + "docfx.analysis-kuromoji.json", + "docfx.analysis-morfologik.json", + "docfx.test-framework.json" ) $DocFxJsonSite = Join-Path -Path $ApiDocsFolder "docfx.site.json" @@ -172,8 +175,13 @@ if ($?) { # TODO: Figure out why this doesn't work as expected, the absolute path isn't quite right. # ... It does work now but we'll see if it breaks with overlapping uids + # ... it seems to work 'sometimes' but not others, very strange, like the analysis-common package has the xref map of 'core' but it doesn't resolve + # which seems a bit strange. Might be time to try to debug in DocFx # // baseUrl: https://xxxx.azurewebsites.net/, https://github.com/dotnet/docfx/issues/2346#issuecomment-356054027 - + # TODO: Look into uidPrefix which is part of the xrefmap (see XRefMapRedirection) + # NOTE: With Info logs, we should see this output when resolving xrefmap: external references found in + # NOTE: THere's a field ThrowIfNotResolved on XRefDetails that might help, as it turns out it looks like via code that the resolved external Xref's + # Don't have an Href field? } } diff --git a/websites/apidocs/toc/analysis-kuromoji/toc.yml b/websites/apidocs/toc/analysis-kuromoji/toc.yml new file mode 100644 index 0000000..dd1fafc --- /dev/null +++ b/websites/apidocs/toc/analysis-kuromoji/toc.yml @@ -0,0 +1,3 @@ +- name: Analysis Kuromoji + href: ../../obj/docfx/api/analysis-kuromoji/toc.yml + topicUid: Lucene.Net.Analysis.Ja \ No newline at end of file diff --git a/websites/apidocs/toc/analysis-morfologik/toc.yml b/websites/apidocs/toc/analysis-morfologik/toc.yml new file mode 100644 index 0000000..67bdcc4 --- /dev/null +++ b/websites/apidocs/toc/analysis-morfologik/toc.yml @@ -0,0 +1,3 @@ +- name: Analysis Morfologik + href: ../../obj/docfx/api/analysis-morfologik/toc.yml + topicUid: Lucene.Net.Analysis.Morfologik \ No newline at end of file
