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: adb812d25c
Branches Tags
gui-cs.Terminal...
/
docfx
Charlie Kindel 75bebb12f9 generated docs 5 years ago
..
articles c4e632dc89 fixing accidental deletion of articles. oops! 5 years ago
images deaa17fd4f updated docs to match new layout 5 years ago
templates 14f08a8d63 Updated docfx. Generated fresh docs. Added an icon. 5 years ago
README.md 75bebb12f9 generated docs 5 years ago
build.ps1 75bebb12f9 generated docs 5 years ago
docfx.json e87b56cd77 updated api docs; implemented inheritdoc; may break deploy 5 years ago
index.md cef0ecc8bb merged master and updated readme release notes 5 years ago
sample.gif 56fbf9819b updated readme gif 5 years ago
sample.png 3befb45673 updated gif 5 years ago
toc.yml deaa17fd4f updated docs to match new layout 5 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.