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 00:18:43 UTC
[lucenenet] 06/09: Includes test-framework in site build - but as
expected, this breaks xref lookups because there's duplicates now,
need to debug that
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 4211a785ecc20dc42e1835543efcaea89b96239f
Author: Shannon <sd...@gmail.com>
AuthorDate: Wed Jun 17 13:42:02 2020 +1000
Includes test-framework in site build - but as expected, this breaks xref lookups because there's duplicates now, need to debug that
---
.../Templates/LuceneTemplateAssets/styles/main.css | 2 +-
websites/apidocs/docfx.test-framework.json | 15 ++++++---------
websites/apidocs/docs.ps1 | 12 ++++--------
websites/apidocs/toc/core/toc.yml | 6 +++---
websites/apidocs/toc/test-framework/toc.yml | 2 +-
5 files changed, 15 insertions(+), 22 deletions(-)
diff --git a/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css b/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css
index 056bc0e..6f11086 100644
--- a/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css
+++ b/websites/apidocs/Templates/LuceneTemplateAssets/styles/main.css
@@ -92,7 +92,7 @@ body .toc {
background-color: rgb(247, 247, 247);
}
-.level1.breadcrumb {
+.level0.breadcrumb .level1.breadcrumb {
display: inline;
}
diff --git a/websites/apidocs/docfx.test-framework.json b/websites/apidocs/docfx.test-framework.json
index 8cd9415..2ad8e81 100644
--- a/websites/apidocs/docfx.test-framework.json
+++ b/websites/apidocs/docfx.test-framework.json
@@ -36,14 +36,10 @@
},
{
"files": [
- "toc/test-framework/toc.yml"
- ]
- },
- {
- "files": [
- "toc.yml"
+ "toc.yml",
+ "test-framework/toc.yml"
],
- "src": "toc/subsite"
+ "src": "toc"
}
],
"overwrite": [
@@ -59,8 +55,9 @@
"docfx.global.subsite.json"
],
"template": [
- "DefaultTemplateNoAssets",
- "LuceneTemplate"
+ "Templates/DefaultTemplateNoAssets",
+ "Templates/LuceneTemplate",
+ "Templates/LuceneApiDocs"
],
"postProcessors": [],
"markdownEngineName": "dfm",
diff --git a/websites/apidocs/docs.ps1 b/websites/apidocs/docs.ps1
index 886661b..77dc91a 100644
--- a/websites/apidocs/docs.ps1
+++ b/websites/apidocs/docs.ps1
@@ -110,11 +110,6 @@ $PluginsFolder = (Join-Path -Path $ApiDocsFolder "lucenetemplate\plugins")
New-Item $PluginsFolder -type directory -force
& $msbuild $pluginSln /target:LuceneDocsPlugins "/p:OutDir=$PluginsFolder"
-# Set the DocFx MSBuild path manually, for some reason it borks if using the default
-# [Environment]::SetEnvironmentVariable("MSBUILD_EXE_PATH", $msbuild)
-# [Environment]::SetEnvironmentVariable("MSBUILD_EXE_PATH", "C:\Program Files (x86)\Microsoft Visual Studio\2019\Enterprise\MSBuild\Current\Bin\MSBuild.exe")
-# [Environment]::SetEnvironmentVariable("VisualStudioVersion", "15.0")
-
# update the docjx.global.json file based
$DocFxGlobalJson = Join-Path -Path $ApiDocsFolder "docfx.global.json"
$DocFxJsonContent = Get-Content $DocFxGlobalJson | ConvertFrom-Json
@@ -124,8 +119,8 @@ $DocFxJsonContent._gitContribute.branch = "docs/$LuceneNetVersion"
$DocFxJsonContent | ConvertTo-Json -depth 100 | Set-Content $DocFxGlobalJson
$DocFxJsonMeta = @(
- "docfx.core.json"
- #"docfx.test-framework.json"
+ "docfx.core.json",
+ "docfx.test-framework.json"
)
$DocFxJsonSite = Join-Path -Path $ApiDocsFolder "docfx.site.json"
@@ -176,8 +171,9 @@ if ($?) {
Set-Content -Path $xrefFile -Value $xrefMap
# 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
# // baseUrl: https://xxxx.azurewebsites.net/, https://github.com/dotnet/docfx/issues/2346#issuecomment-356054027
- # TODO: We want to make the breadcrumb like microsofts so that the first segment of it is the home page.
+
}
}
diff --git a/websites/apidocs/toc/core/toc.yml b/websites/apidocs/toc/core/toc.yml
index c62eed1..4e15a2e 100644
--- a/websites/apidocs/toc/core/toc.yml
+++ b/websites/apidocs/toc/core/toc.yml
@@ -1,3 +1,3 @@
-- name: Core
- topicUid: Lucene.Net
- href: ../../obj/docfx/api/core/toc.yml
\ No newline at end of file
+- name: Core
+ href: ../../obj/docfx/api/core/toc.yml
+ topicUid: Lucene.Net
\ No newline at end of file
diff --git a/websites/apidocs/toc/test-framework/toc.yml b/websites/apidocs/toc/test-framework/toc.yml
index c802568..e303b2a 100644
--- a/websites/apidocs/toc/test-framework/toc.yml
+++ b/websites/apidocs/toc/test-framework/toc.yml
@@ -1,3 +1,3 @@
-- name: Lucene.Net.TestFramework
+- name: Test Framework
href: ../../obj/docfx/api/test-framework/toc.yml
topicUid: Lucene.Net.TestFramework
\ No newline at end of file