infer/docs в 7efac3528b1c74ec4d62a82030e80d18ba2c99ed - infer - Git

История

dotnet-bot 73207ecc9c Initial commit		2018-10-01 11:32:06 -07:00
..
PrepareSource	Initial commit	2018-10-01 11:32:06 -07:00
_build	Initial commit	2018-10-01 11:32:06 -07:00
images	Initial commit	2018-10-01 11:32:06 -07:00
template/styles	Initial commit	2018-10-01 11:32:06 -07:00
README.md	Initial commit	2018-10-01 11:32:06 -07:00
docfx.json	Initial commit	2018-10-01 11:32:06 -07:00
favicon.ico	Initial commit	2018-10-01 11:32:06 -07:00
index.md	Initial commit	2018-10-01 11:32:06 -07:00
toc.yml	Initial commit	2018-10-01 11:32:06 -07:00

README.md

Build API documentation

The API documentation is generated by using DocFX. The last version of the API documentation is in the apiguide/ folder. If you want to create a new version of the API documentation:

Commit your changes before start the build process.
Run the powershell script docs/_build/makeApiDocs.ps1. makeApiDocs.ps1 script should create the folder apiguide-tmp/ with the API documentation.

makeApiDocs.ps1 script should:

copy a part of repository to the temporary folder InferNet_Copy_Temp,
build PrepareSource.csproj project,
run PrepareSource.exe for the InferNet_Copy_Temp folder,
install NuGet package docfx.console,
run docfx,
remove temporary folder InferNet_Copy_Temp,
switch to gh-pages,
commit and push the new changes.