Tig Kindel
c6001c794b
Fixes #2025 - API Docs are now generated via Github Action - View Source Works (#2027)
|
3 年 前 | |
|---|---|---|
| .. | ||
| _exported_templates | 3 年 前 | |
| articles | 3 年 前 | |
| images | 3 年 前 | |
| templates | 3 年 前 | |
| README.md | 3 年 前 | |
| aboutbox.png | 4 年 前 | |
| build.ps1 | 3 年 前 | |
| docfx.json | 3 年 前 | |
| index.md | 3 年 前 | |
| runbuild.cmd | 3 年 前 | |
| toc.yml | 3 年 前 | |
README.md
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
./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.
Note the ./docfx/build.ps1 script will create a ./docs folder. This folder is ignored by .gitignore.