mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-26 15:57:56 +01:00
c6001c794b
* Fixes #1991 - Broken link in README * Force push to main to update api docs after fixing #1874 * Fixes #1745 - Github action to generate API docs * Try 2 - Fixes #1745 - Github action to generate API docs * Try 3 - Fixes #1745 - Github action to generate API docs * Try 4 - Fixes #1745 - Github action to generate API docs * Try 4 - Fixes #1745 - Github action to generate API docs * Try 6 - Fixes #1745 - Github action to generate API docs * Removed docs folder because gh-pages branch is now used * Ignore ./docs folder * Fix readme for docfx * Revert "merge" This reverts commit870a241d5d, reversing changes made to48089bb31c.
54 lines
1.4 KiB
YAML
54 lines
1.4 KiB
YAML
name: Build and publish API docs
|
|
|
|
on:
|
|
push:
|
|
branches: [main]
|
|
|
|
jobs:
|
|
generate-docs:
|
|
runs-on: windows-latest
|
|
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v2
|
|
|
|
- name: Setup .NET Core
|
|
uses: actions/setup-dotnet@v1
|
|
with:
|
|
dotnet-version: 6.0.100
|
|
|
|
- name: Setup DocFX
|
|
uses: crazy-max/ghaction-chocolatey@v1
|
|
with:
|
|
args: install docfx
|
|
|
|
- name: Install dependencies
|
|
run: dotnet restore
|
|
|
|
- name: DocFX Build
|
|
working-directory: docfx
|
|
# https://stackoverflow.com/questions/56726429/how-to-run-multiple-commands-in-one-github-actions-docker
|
|
run: |
|
|
rm ../docs -Recurse -Force
|
|
docfx docfx.json
|
|
continue-on-error: false
|
|
|
|
- name: Publish
|
|
if: github.event_name == 'push'
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: docs
|
|
force_orphan: true
|
|
|
|
# - name: Use docfx to build API Docs
|
|
# uses: nikeee/docfx-action@v1.0.0
|
|
# with:
|
|
# args: docfx/docfx.json
|
|
|
|
# # Publish generated site using GitHub Pages
|
|
# - uses: maxheld83/ghpages@master
|
|
# name: Publish API Documentation on GitHub Pages
|
|
# env:
|
|
# BUILD_DIR: docs # docfx's default output directory is _site
|
|
# GH_PAT: ${{ secrets.GH_PAT }} # See https://github.com/maxheld83/ghpages |