Skip to content

Commit

Permalink
Merge pull request #50 from aws/asmarp/update-doc-site
Browse files Browse the repository at this point in the history
docs: update doc site to new template
  • Loading branch information
philasmar authored Jan 16, 2024
2 parents 3a5ab48 + f47fd63 commit 3fb2e20
Show file tree
Hide file tree
Showing 62 changed files with 371 additions and 20,907 deletions.
47 changes: 47 additions & 0 deletions .github/workflows/doc-site.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: Generate API Reference

# Trigger the action on push to main
on:
push:
branches:
- main

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

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
publish-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Dotnet Setup
uses: actions/setup-dotnet@v3
with:
dotnet-version: 8.x

- run: dotnet tool update -g docfx --version 2.74.0
- run: docfx docs/docfx.json

- name: Setup Pages
uses: actions/configure-pages@v3
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
# Upload entire repository
path: 'docs/_site'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
6 changes: 5 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -36,4 +36,8 @@ generator/.vs/**

**/*.partial.sln
**/*.partial.FxCop
**/*.partial.csproj
**/*.partial.csproj

# DocFx
docs/_site/
docs/api/
9 changes: 0 additions & 9 deletions docfx_project/.gitignore

This file was deleted.

5 changes: 0 additions & 5 deletions docfx_project/api/.gitignore

This file was deleted.

1 change: 0 additions & 1 deletion docfx_project/articles/intro.md

This file was deleted.

2 changes: 0 additions & 2 deletions docfx_project/articles/toc.yml

This file was deleted.

68 changes: 0 additions & 68 deletions docfx_project/docfx.json

This file was deleted.

38 changes: 0 additions & 38 deletions docfx_project/images/AWS_logo_RGB_REV.svg

This file was deleted.

2 changes: 0 additions & 2 deletions docfx_project/toc.yml

This file was deleted.

Loading

0 comments on commit 3fb2e20

Please sign in to comment.