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

generated docs

Browse Source
This commit is contained in:
Charlie Kindel
2020-10-22 12:31:38 -06:00
parent a87bfdbb38
commit 75bebb12f9
44 changed files with 1882 additions and 1295 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docfx/README.md
View File

@@ -4,9 +4,9 @@ The API documentation is generated using the [DocFX tool](https://github.com/dot
## 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.
0. Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
1. Change to the `./docfx` folder and run `./build.ps1`
2. Browse to http://localhost:8080 and verify everything looks good.
3. 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.