csharp/gui-cs.Terminal.Gui @ b8a0f415f2ae37bd95fb2c3cb1566f2898fe434d

Tig b3a5b78d64 Merge pull request #2111 from tznind/simple-example		2 lat temu
..
_exported_templates	0dcbdb847c Tweaked API docs format and content. Fixed build warnings.	3 lat temu
articles	7e2e7b9d2d Updates v1.7 docs (#1919)	3 lat temu
images	121d0a0cc8 Update 'Sample Usage' README.md section	2 lat temu
overrides	a69ceb2a29 testing improve this doc...	2 lat temu
templates	7e2e7b9d2d Updates v1.7 docs (#1919)	3 lat temu
README.md	70ca1a854e Adds new workflow for generating API docs via Github action	2 lat temu
aboutbox.png	7f27d78cc7 Release Candiate 2 (#1248)	4 lat temu
build.ps1	d06dd3f599 fixes doc script	2 lat temu
docfx.json	68ddc4295a Puts API doc overrides in ./docfx/overrides folder	2 lat temu
index.md	7e2e7b9d2d Updates v1.7 docs (#1919)	3 lat temu
runbuild.cmd	239191cde0 Fixes #1434. Regenerating the docs. (#1528)	3 lat temu
toc.yml	3a7efd0cdf Fixes #1889. Docs broken after org move.	3 lat temu

This folder generates the API docs for Terminal.Gui.

The API documentation is generated via a GitHub Action (.github/workflows/api-docs.yml) using DocFX. The Action publishes the docs to the gh-pages branch, which gets published to https://gui-cs.github.io/Terminal.Gui/.

To Generate the Docs Locally

Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
Change to the ./docfx folder and run ./build.ps1
Browse to http://localhost:8080 and verify everything looks good.
Hit ctrl-c to stop the script.

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.

Note the ./docfx/build.ps1 script will create a ./docs folder. This folder is ignored by .gitignore.

README.md

To Generate the Docs Locally