dotMorten/NmeaParser
1
0
Fork 0
mirror of https://github.com/dotMorten/NmeaParser.git synced 2026-04-21 06:13:58 +00:00
Code Issues Projects Releases Packages Wiki Activity

Fix build warnings and update doc builds

Browse source
This commit is contained in:
Morten Nielsen 2023-11-30 17:09:33 -08:00
parent 1164e20270
commit 5cecd3c129
8 changed files with 91 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/AppliesToGenerator/DocFXAppliesToGenerator.csproj
View file

@ -2,7 +2,7 @@
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>netcoreapp3.1</TargetFramework>
<TargetFramework>net6.0</TargetFramework>
</PropertyGroup>
</Project>

7
docs/BuildDoc.cmd
View file

@ -1,6 +1,6 @@
@ECHO OFF
SET DocFXVersion=2.58
SET DocFXVersion=2.59.0
SET DocFxFolder=%~dp0..\.tools\docfx
REM Download DocFx
@ -20,13 +20,14 @@ dotnet tool install --tool-path %~dp0../.tools/omd dotMorten.OmdGenerator --vers
mkdir %~dp0../artifacts/docs/api
%~dp0..\.tools\omd\generateomd /source=%~dp0../src/NmeaParser /output=%~dp0../artifacts/docs/api/omd.html /preprocessors=NETSTANDARD1_4;NETSTANDARD
%~dp0..\.tools\nuget install memberpage -Version 2.58.0 -OutputDirectory %~dp0
%~dp0..\.tools\nuget install memberpage -Version %DocFXVersion% -OutputDirectory %~dp0
REM Build the output site (HTML) from the generated metadata and input files (uses configuration in docfx.json in this folder)
%DocFxFolder%\v%DocFXVersion%\docfx.exe metadata %~dp0\docfx.json
REM Build applies-to version/framework info
dotnet build AppliesToGenerator\DocFXAppliesToGenerator.csproj
AppliesToGenerator\bin\Debug\netcoreapp3.1\DocFXAppliesToGenerator.exe appliesToList.json
AppliesToGenerator\bin\Debug\net6.0\DocFXAppliesToGenerator.exe appliesToList.json
%DocFxFolder%\v%DocFXVersion%\docfx.exe build %~dp0\docfx.json

30
docs/appliesToList.json
View file

@ -54,6 +54,34 @@
{ "Name" : "v2.1", "Manifest": "manifests/v2.1/uwp/.manifest" },
{ "Name" : "v2.0", "Manifest": "manifests/v2.0/uwp/.manifest" }
]
}
},
{
"PlatformName": ".NET 6+",
"Versions" : [
{ "Name": "GitHub", "Manifest": "../artifacts/docs/api/net/.manifest" },
{ "Name" : "v2.3", "Manifest": "manifests/v2.3/net/.manifest" }
]
},
{
"PlatformName": ".NET Android",
"Versions" : [
{ "Name": "GitHub", "Manifest": "../artifacts/docs/api/net-android/.manifest" },
{ "Name" : "v2.3", "Manifest": "manifests/v2.3/net-android/.manifest" }
]
},
{
"PlatformName": ".NET iOS",
"Versions" : [
{ "Name": "GitHub", "Manifest": "../artifacts/docs/api/net-ios/.manifest" },
{ "Name" : "v2.3", "Manifest": "manifests/v2.3/net-ios/.manifest" }
]
},
{
"PlatformName": ".NET Windows",
"Versions" : [
{ "Name": "GitHub", "Manifest": "../artifacts/docs/api/net-windows/.manifest" },
{ "Name" : "v2.3", "Manifest": "manifests/v2.3/net-windows/.manifest" }
]
},
]
}

72
docs/docfx.json
View file

@ -6,62 +6,84 @@
"files": [ "NmeaParser/NmeaParser.csproj" ],
"src" : "../src/"
},
],
],
"dest": "../artifacts/docs/api/netstd",
"properties": { "TargetFramework": "netstandard1.4" },
"disableGitFeatures": false,
"disableDefaultFilter": false
},
{ "src": [
{ "src": [
{
"files": [ "NmeaParser/NmeaParser.csproj" ],
"src" : "../src/"
}
],
],
"dest": "../artifacts/docs/api/netfx",
"properties": { "TargetFramework": "net452" },
"disableGitFeatures": false,
"disableDefaultFilter": false
},
{ "src": [
{ "src": [
{
"files": [ "NmeaParser/NmeaParser.csproj" ],
"src" : "../src/"
}
],
"dest": "../artifacts/docs/api/netcore",
"properties": { "TargetFramework": "netcoreapp2.1" },
"disableGitFeatures": false,
"disableDefaultFilter": false
},
{ "src": [
{
"files": [ "NmeaParser/NmeaParser.csproj" ],
"src" : "../src/"
}
],
],
"dest": "../artifacts/docs/api/android",
"properties": { "TargetFramework": "monoandroid70" },
"disableGitFeatures": false,
"disableDefaultFilter": false
},
{ "src": [
{ "src": [
{
"files": [ "NmeaParser/NmeaParser.csproj" ],
"src" : "../src/"
}
],
],
"dest": "../artifacts/docs/api/net-android",
"properties": { "TargetFramework": "net7.0-android" },
"disableGitFeatures": false,
"disableDefaultFilter": false
},
{ "src": [
{
"files": [ "NmeaParser/NmeaParser.csproj" ],
"src" : "../src/"
}
],
"dest": "../artifacts/docs/api/ios",
"properties": { "TargetFramework": "xamarinios10" },
"disableGitFeatures": false,
"disableDefaultFilter": false
},
{ "src": [
{ "src": [
{
"files": [ "NmeaParser/NmeaParser.csproj" ],
"src" : "../src/"
}
],
],
"dest": "../artifacts/docs/api/net-ios",
"properties": { "TargetFramework": "net7.0-ios" },
"disableGitFeatures": false,
"disableDefaultFilter": false
},
{ "src": [
{
"files": [ "NmeaParser/NmeaParser.csproj" ],
"src" : "../src/"
}
],
"dest": "../artifacts/docs/api/net-windows",
"properties": { "TargetFramework": "net6.0-windows10.0.19041.0" },
"disableGitFeatures": false,
"disableDefaultFilter": false
},
{ "src": [
{
"files": [ "NmeaParser/NmeaParser.csproj" ],
"src" : "../src/"
}
],
"dest": "../artifacts/docs/api/uwp",
"properties": { "TargetFramework": "uap10.0.18362" },
"disableGitFeatures": false,
@ -70,7 +92,7 @@
],
"build": {
"content": [
{
{
"files": [
"api/**/index.md"
]
@ -80,7 +102,7 @@
"api/**.yml",
"api/**/toc.yml"
],
"src" : "../artifacts/docs"
"src" : "../artifacts/docs"
},
{
"files": [
@ -98,11 +120,11 @@
"favicon.ico"
]
},
{
{
"files": [
"api/omd.html"
],
"src" : "../artifacts/docs"
"src" : "../artifacts/docs"
}
],
"overwrite": [
@ -134,7 +156,7 @@
"fileMetadataFiles": [],
"template": [
"default",
"memberpage.2.58.0/content",
"memberpage.2.59.0/content",
"template_overrides"
],
"postProcessors": [],