From d1c53a3147d48d686710f1223f7fb6ed9ef4d1a3 Mon Sep 17 00:00:00 2001 From: Charlie Kindel Date: Sat, 6 Jun 2020 23:43:29 -0600 Subject: [PATCH] added docfx readme --- docfx/README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 docfx/README.md diff --git a/docfx/README.md b/docfx/README.md new file mode 100644 index 000000000..0cc994d6a --- /dev/null +++ b/docfx/README.md @@ -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 `/// ` 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.