Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-26 15:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

added docfx readme

Browse Source
This commit is contained in:
Charlie Kindel
2020-06-06 23:43:29 -06:00
parent 091044b159
commit d1c53a3147
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docfx/README.md Normal file
View File

@@ -0,0 +1,10 @@
This folder generates the API docs for Terminal.Gui
## To Generate the Docs
1. Do a `Release` build on `master`. This will cause all `/// <inheritdoc/>` references to be updated.
2. Change in to the `docfx/` directory.
3. Type `docfx --metadata` to generate metadata
4. Type `docfx --serve` to generate the docs and start a local webserver for testing.
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.