Home Explore Help
Sign In
csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: b0a43ba338
Branches Tags
gui-cs.Terminal...
/
docfx
Tig Kindel 3a7efd0cdf Fixes #1889. Docs broken after org move. 3 years ago
..
_exported_templates 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. 3 years ago
articles 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. 3 years ago
images 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. 3 years ago
templates 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. 3 years ago
README.md 75bebb12f9 generated docs 5 years ago
aboutbox.png 7f27d78cc7 Release Candiate 2 (#1248) 4 years ago
build.ps1 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. 3 years ago
docfx.json 94f36cef2e Updated API doc theme. Added Wizard Sample 3 years ago
index.md 3a7efd0cdf Fixes #1889. Docs broken after org move. 3 years ago
runbuild.cmd 239191cde0 Fixes #1434. Regenerating the docs. (#1528) 4 years ago
toc.yml 3a7efd0cdf Fixes #1889. Docs broken after org move. 3 years ago

README.md

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

  1. Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
  2. Change to the ./docfx folder and run ./build.ps1
  3. Browse to http://localhost:8080 and verify everything looks good.
  4. 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.