Skip to content

Latest commit

 

History

History
17 lines (14 loc) · 812 Bytes

README.md

File metadata and controls

17 lines (14 loc) · 812 Bytes

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:

  1. Commit your changes before start the build process.
  2. 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.