mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
7f27d78cc7
* tweaked version # for v1.0.0-beta.10 * tweaked version # for v1.0.0-beta.11 * Updated readme and revision history for 1.0 * tweaked rel notes * Regenerated docs for v1.0.0.0 * updating build docs * updating docs * updated readme * updated readme * more docs * more docs * Refactored for clarity * tweaks * updated info on versioning * merged with main. updated relnotes * updated api docs * updated README to point to new docs * merged from future v1.0.0 branch * regen apidocs * add code coverage badge generation to publish * add code coverage badge generation to publish * tweaked badge
This folder generates the API docs for Terminal.Gui.
The API documentation is generated using the DocFX tool. The output of docfx gets put into the ./docs folder which is then checked in. The ./docs folder is then picked up by Github Pages and published to Miguel's Github Pages (https://migueldeicaza.github.io/gui.cs/).
To Generate the Docs
- Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
- Change to the
./docfxfolder 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.