Charlie Kindel
19b438ca74
Version 1.0 (#1227)
|
há 4 anos atrás | |
|---|---|---|
| .. | ||
| articles | há 4 anos atrás | |
| images | há 5 anos atrás | |
| templates | há 5 anos atrás | |
| README.md | há 4 anos atrás | |
| aboutbox.png | há 4 anos atrás | |
| build.ps1 | há 4 anos atrás | |
| docfx.json | há 5 anos atrás | |
| index.md | há 4 anos atrás | |
| sample.gif | há 4 anos atrás | |
| sample.png | há 5 anos atrás | |
| toc.yml | há 5 anos atrás | |
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
- 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.