To generate the Artemis API docs we use DocFX.
To build locally run the following commands from this folder.
- Ensure you can build the Artemis solution as per the main build instructions
- Install DocFX (with Chocolatey:
choco install docfx
) - Open PowerShell in
<repo>\docfx
(the same folder as this readme file) - Run
docfx .\docfx_project\docfx.json
to build static files
Rundocfx .\docfx_project\docfx.json --serve
to serve locally