Adds new workflow for generating API docs via Github action

This commit is contained in:
Charlie Kindel
2022-09-17 08:59:30 -06:00
parent ebf576df7a
commit 70ca1a854e
2 changed files with 55 additions and 1 deletions

View File

@@ -11,4 +11,4 @@ The API documentation is generated via a GitHub Action (`.github/workflows/api-d
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`.
Note the `./docfx/build.ps1` script will create a `./docs` folder. This folder is ignored by `.gitignore`.