mirror of
https://github.com/dotMorten/NmeaParser.git
synced 2026-04-07 07:24:04 +00:00
Added DocFX documentation
This commit is contained in:
parent
9a32f41edf
commit
3571fdec12
25 changed files with 563 additions and 0 deletions
18
build/DownloadDocFX.ps1
Normal file
18
build/DownloadDocFX.ps1
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
[cmdletbinding()]
|
||||
param([string]$Version="2.48.1",[string]$Folder)
|
||||
Add-Type -AssemblyName System.IO.Compression.FileSystem
|
||||
[Net.ServicePointManager]::SecurityProtocol =[Net.SecurityProtocolType]::Tls12
|
||||
|
||||
function DownloadDocFX([string]$version, [string]$folder)
|
||||
{
|
||||
Write-Output "Using folder $folder"
|
||||
$path = "$folder\v$version"
|
||||
if (!(Test-Path $path))
|
||||
{
|
||||
New-Item -ItemType Directory -Force -Path $path
|
||||
Write-Output "Downloading DocFX v$version..."
|
||||
Invoke-WebRequest -Uri "https://github.com/dotnet/docfx/releases/download/v$version/docfx.zip" -OutFile "$folder\docfx_v$version.zip"
|
||||
[System.IO.Compression.ZipFile]::ExtractToDirectory("$folder\docfx_v$version.zip",$path )
|
||||
}
|
||||
}
|
||||
DownloadDocFX -version $Version -folder $Folder
|
||||
20
build/GenerateDoc.cmd
Normal file
20
build/GenerateDoc.cmd
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
@ECHO OFF
|
||||
|
||||
SET DocFXVersion=2.48.1
|
||||
SET DocFxFolder=..\artifacts\toolset
|
||||
|
||||
REM Download DocFx
|
||||
powershell -ExecutionPolicy ByPass -command "./DownloadDocFX.ps1" -Version %DocFXVersion% -Folder %DocFxFolder%
|
||||
|
||||
REM Build metadata for all platforms (uses configuration in docfx.json in this folder)
|
||||
%DocFxFolder%\v%DocFXVersion%\docfx.exe ..\docs\docfx.json metadata
|
||||
|
||||
REM Merge output (not implemented)
|
||||
REM %DocFxFolder%\v%DocFXVersion%\docfx.exe merge
|
||||
|
||||
REM Generate OMD
|
||||
dotnet tool install --global dotMorten.OmdGenerator
|
||||
generateomd /source=../src/NmeaParser /output=../artifacts/docs/api/omd.html
|
||||
|
||||
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 ..\docs\docfx.json build
|
||||
Loading…
Add table
Add a link
Reference in a new issue