mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
c6001c794b
* Fixes #1991 - Broken link in README * Force push to main to update api docs after fixing #1874 * Fixes #1745 - Github action to generate API docs * Try 2 - Fixes #1745 - Github action to generate API docs * Try 3 - Fixes #1745 - Github action to generate API docs * Try 4 - Fixes #1745 - Github action to generate API docs * Try 4 - Fixes #1745 - Github action to generate API docs * Try 6 - Fixes #1745 - Github action to generate API docs * Removed docs folder because gh-pages branch is now used * Ignore ./docs folder * Fix readme for docfx * Revert "merge" This reverts commit870a241d5d, reversing changes made to48089bb31c.
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.