Skip to content

add API document github page #1114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Dec 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions .github/workflows/docfx.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
name: Docfx

on:
push:
branches: [ master ]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
docfx:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Setup dotnet
uses: actions/setup-dotnet@v3
with:
dotnet-version: |
3.1.x
5.0.x
6.0.x

- name: Build
run: dotnet build

- uses: nikeee/docfx-action@v1.0.0
name: Build Documentation
with:
args: doc/docfx.json

- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: doc/_site
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
11 changes: 11 additions & 0 deletions doc/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/
_site

api
42 changes: 42 additions & 0 deletions doc/docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
{
"metadata": [
{
"src": [
{
"files": [
"KubernetesClient.Basic/bin/Debug/netstandard2.0/KubernetesClient.Basic.dll",
"KubernetesClient.Models/bin/Debug/netstandard2.0/KubernetesClient.Models.dll",
"KubernetesClient/KubernetesClient.csproj"
],
"src": "../src"
}
],
"dest": "api",
"disableGitFeatures": false,
"disableDefaultFilter": false
}
],
"build": {
"content": [
{
"files": [
"api/**.yml",
"index.md",
"toc.yml"
]
}
],
"dest": "_site",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default"
],
"postProcessors": [],
"markdownEngineName": "markdig",
"noLangKeyword": false,
"keepFileLink": false,
"cleanupCacheHistory": false,
"disableGitFeatures": false
}
}
1 change: 1 addition & 0 deletions doc/index.md
2 changes: 2 additions & 0 deletions doc/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: API Documentation
href: api/k8s.yml