Charlie Kindel
This folder generates the API docs for Terminal.Gui
To Generate the Docs
- Do a
Releasebuild onmaster. This will cause all/// <inheritdoc/>references to be updated. - Change in to the
docfx/directory. - Type
docfx --metadatato generate metadata - Type
docfx --serveto generate the docs and start a local webserver for testing.
If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api, docfx/obj, and docs/ folders and run the steps above again.