Skip to content

Commit

Permalink
[Docs] First pass on DocFX generation
Browse files Browse the repository at this point in the history
  • Loading branch information
Syncaidius committed Jul 28, 2023
1 parent 85e09a7 commit 5929c10
Show file tree
Hide file tree
Showing 98 changed files with 6,345 additions and 1,040 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/doc-gen.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Generate Documentation
on:
push:
branches: [Release, NewDocGen]

jobs:
generate-docs:
runs-on: windows-latest
env:
DOTNET_VERSION: 7.0.x

steps:
- name: Checkout
uses: actions/checkout@v3

- name: Install .NET [${{ env.DOTNET_VERSION }}]
uses: actions/setup-dotnet@v3
with:
dotnet-version: ${{ env.DOTNET_VERSION }}

- name: Install DocFX
uses: crazy-max/ghaction-chocolatey@v2
with:
args: install docfx

- name: Install dependencies
run: dotnet restore

- name: DocFX Build
working-directory: docs
run: 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
9 changes: 9 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
###############
# folder #
###############
/**/DROP/
/**/TEMP/
/**/packages/
/**/bin/
/**/obj/

4 changes: 4 additions & 0 deletions docs/api/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
###############
# temp file #
###############
.manifest
2 changes: 2 additions & 0 deletions docs/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# PLACEHOLDER
TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!
2 changes: 2 additions & 0 deletions docs/api/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: TO BE REPLACED
href: index.md
1 change: 1 addition & 0 deletions docs/articles/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Add your introductions here!
2 changes: 2 additions & 0 deletions docs/articles/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: Introduction
href: intro.md
Loading

0 comments on commit 5929c10

Please sign in to comment.