From ebf576df7acb5c788aefb0a5b87932a57dd4f164 Mon Sep 17 00:00:00 2001 From: Charlie Kindel Date: Sat, 17 Sep 2022 08:56:33 -0600 Subject: [PATCH] Updates docfx README to refelect gh-pages --- docfx/README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docfx/README.md b/docfx/README.md index c12d87a75..ccffd37e0 100644 --- a/docfx/README.md +++ b/docfx/README.md @@ -1,8 +1,8 @@ This folder generates the API docs for Terminal.Gui. -The API documentation is generated using the [DocFX tool](https://github.com/dotnet/docfx). The output of docfx gets put into the `./docs` folder which is then checked in. The `./docs` folder is then picked up by Github Pages and published to Miguel's Github Pages (https://migueldeicaza.github.io/gui.cs/). +The API documentation is generated via a GitHub Action (`.github/workflows/api-docs.yml`) using [DocFX](https://github.com/dotnet/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 +## To Generate the Docs Locally 0. Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html 1. Change to the `./docfx` folder and run `./build.ps1` @@ -10,3 +10,5 @@ The API documentation is generated using the [DocFX tool](https://github.com/dot 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. + +Note the `./docfx/build.ps1` script will create a `./docs` folder. This folder is ignored by `.gitignore`. \ No newline at end of file