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: 6851b42a49
Branches Tags
gui-cs.Terminal...
/
docfx
Tig dea5f0fe03 Fixes #2597. Enables standard glyphs to be set via ConfigurationManager (#2595) 2 years ago
..
_exported_templates 0dcbdb847c Tweaked API docs format and content. Fixed build warnings. 3 years ago
articles dea5f0fe03 Fixes #2597. Enables standard glyphs to be set via ConfigurationManager (#2595) 2 years ago
images 9425b2a720 Fixes #2181 - (Really) Adds configuration manager (#2365) 2 years ago
overrides a69ceb2a29 testing improve this doc... 3 years ago
schemas 9425b2a720 Fixes #2181 - (Really) Adds configuration manager (#2365) 2 years ago
templates 7e2e7b9d2d Updates v1.7 docs (#1919) 3 years ago
v2specs 584dc27ee1 Fixed layouttests including textdirection 2 years ago
README.md 70ca1a854e Adds new workflow for generating API docs via Github action 3 years ago
aboutbox.png 7f27d78cc7 Release Candiate 2 (#1248) 4 years ago
build.ps1 dea5f0fe03 Fixes #2597. Enables standard glyphs to be set via ConfigurationManager (#2595) 2 years ago
docfx.json 9425b2a720 Fixes #2181 - (Really) Adds configuration manager (#2365) 2 years ago
index.md 9425b2a720 Fixes #2181 - (Really) Adds configuration manager (#2365) 2 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 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

  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.

Note the ./docfx/build.ps1 script will create a ./docs folder. This folder is ignored by .gitignore.