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

Fix readme for docfx

Browse Source
This commit is contained in:
Charlie Kindel
2022-09-16 10:15:05 -06:00
parent e47a8c5e6c
commit 48089bb31c
1 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docfx/README.md
View File

@@ -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`.