SUGAR Unity's documentation is generated using DocFX using tripple slash code comments and DicFX .md and .toc files located in docs/.
- DocFX
- "docfx" as a command needs to be availabe via the command console for the scripts to work.
- PDF documentation requires wkhtmltopdf.
There are various build scripts in docs/tools to build, copy and serve the docs.
Tool | Function
- | - all.bat | Build the docs site and pdf. copy_to_unity.bat | Copy the built pdf into the unity project. all_and_copy.bat | all.bat and copy_to_unity.bat metadata_build_and_serve.bat | Build the site and serve. Use this to test the generated docs. metadata_pdf.bat | Build the pdf.
Note: The PDF docfx config was created by following this guide.