github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Generate Doc Index (#579)

Browse Source 
* Generate doc index
* Remove template from doc index. This is used to validate that listing and linking works (it does)
* add template back into excludes
* exclude 'performance-stress'
This commit is contained in:
Daniel Jurek 2020-09-04 11:01:26 -07:00 committed by GitHub
parent 30112e3fcd
commit fea1481217
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
eng/docs/index/Generate-DocIndex.ps1
View File

@ -7,8 +7,8 @@ Param (
)
$ServiceMapping = @{
"core"="Core";
"storage"="Storage";
"core" = "Core";
"storage" = "Storage";
}
Write-Verbose "Name Reccuring paths with variable names"
@ -24,23 +24,17 @@ Copy-Item "${DocGenDir}/templates/*" -Destination "${DocOutDir}/templates" -Forc
Copy-Item "${DocGenDir}/docfx.json" -Destination "${DocOutDir}/" -Force
Write-Verbose "Creating Index using service directory and package names from repo..."
$ServiceList = Get-ChildItem "$($RepoRoot)/sdk" -Directory -Exclude eng, mgmtcommon, template | Sort-Object
$ServiceList = Get-ChildItem "$($RepoRoot)/sdk" -Directory -Exclude template | Sort-Object
$YmlPath = "${DocOutDir}/api"
New-Item -Path $YmlPath -Name "toc.yml" -Force
$TargetServices = $ServiceList | Where-Object { $ServiceMapping.Contains($_.Name) }
Write-Verbose "Creating Index for client packages..."
foreach ($Dir in $TargetServices)
foreach ($Dir in $ServiceList)
{
# Generate a new top-level md file for the service
New-Item -Path $YmlPath -Name "$($Dir.Name).md" -Force
# Add service to toc.yml
$ServiceName = If ($ServiceMapping.Contains($Dir.Name)) { $ServiceMapping[$Dir.Name] } Else { $Dir.Name }
Add-Content -Path "$($YmlPath)/toc.yml" -Value "- name: $($ServiceName)`r`n href: $($Dir.Name).md"
$PkgList = Get-ChildItem $Dir.FullName -Directory -Exclude .vs, .vscode
$PkgList = Get-ChildItem $Dir.FullName -Directory -Exclude .vs, .vscode, performance-stress
if (($PkgList | Measure-Object).count -eq 0)
{
@ -50,21 +44,18 @@ foreach ($Dir in $TargetServices)
Add-Content -Path "$($YmlPath)/$($Dir.Name).md" -Value "---"
Write-Verbose "Operating on Client Packages for $($Dir.Name)"
# Generate a new md file for each package in the service
foreach ($Pkg in $PkgList)
{
if (Test-Path "$($pkg.FullName)\package.txt")
if (Test-Path "$($Pkg.FullName)\src")
{
$ProjectName = Get-Content "$($pkg.FullName)\package.txt"
Add-Content -Path "$($YmlPath)/$($Dir.Name).md" -Value "#### $($ProjectName)"
Add-Content -Path "$($YmlPath)/$($Dir.Name).md" -Value "#### $($Pkg.BaseName)"
}
}
}
Write-Verbose "Creating Site Title and Navigation..."
New-Item -Path "${DocOutDir}" -Name "toc.yml" -Force
Add-Content -Path "${DocOutDir}/toc.yml" -Value "- name: Azure SDK for C APIs`r`n href: api/`r`n homepage: api/index.md"
Add-Content -Path "${DocOutDir}/toc.yml" -Value "- name: Azure SDK for C++ APIs`r`n href: api/`r`n homepage: api/index.md"
Write-Verbose "Copying root markdowns"
Copy-Item "$($RepoRoot)/README.md" -Destination "${DocOutDir}/api/index.md" -Force

4
eng/docs/index/docfx.json
View File

@ -47,8 +47,8 @@
"cleanupCacheHistory": false,
"disableGitFeatures": false,
"globalMetadata": {
"_appTitle": "Azure SDK for C",
"_appFooter": "Azure SDK for C",
"_appTitle": "Azure SDK for C++",
"_appFooter": "Azure SDK for C++",
"_enableSearch": false,
"_enableNewTab": true,
"_appFaviconPath": "https://c.s-microsoft.com/favicon.ico?v2",

2
eng/docs/index/templates/matthews/styles/main.js
View File

@ -4,7 +4,7 @@ containers.removeClass("container");
containers.addClass("container-fluid");
WINDOW_CONTENTS = window.location.href.split('/');
SELECTED_LANGUAGE = 'c';
SELECTED_LANGUAGE = 'cpp';
STORAGE_ACCOUNT_NAME = 'azuresdkdocs';
BLOB_URI_PREFIX = "https://" + STORAGE_ACCOUNT_NAME + ".blob.core.windows.net/$web/" + SELECTED_LANGUAGE + "/";