From 3a2d588142442a0c179712901e388a2d053c1d63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Chalet?= Date: Sun, 17 Jan 2021 17:53:08 +0100 Subject: [PATCH] Add API documentation --- .github/workflows/build.yml | 6 ++++++ .gitmodules | 3 +++ docfx.json | 19 +++++++++++++++++++ submodules/openiddict-core | 1 + toc.yml | 5 ++++- 5 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 .gitmodules create mode 160000 submodules/openiddict-core diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ee40fc9..872d02d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -16,6 +16,12 @@ jobs: - name: Checkout code uses: actions/checkout@v2 + - name: Checkout submodule + uses: actions/checkout@v2 + with: + repository: openiddict/openiddict-core + path: submodules/openiddict-core + - name: Build documentation uses: nikeee/docfx-action@master with: diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 0000000..fdf2d2f --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "submodules/openiddict-core"] + path = submodules/openiddict-core + url = https://github.com/openiddict/openiddict-core diff --git a/docfx.json b/docfx.json index b9ab07a..e4f47fd 100644 --- a/docfx.json +++ b/docfx.json @@ -1,4 +1,22 @@ { + "metadata": [ + { + "src": [ + { + "src": "submodules/openiddict-core", + "files": [ + "src/**/*.cs" + ], + "exclude": [ + "**/bin/**", + "**/obj/**", + "_site/**" + ] + } + ], + "dest": "api" + } + ], "build": { "content": [ { @@ -10,6 +28,7 @@ "appveyor.yml", "README.md", "SECURITY.md", + "submodules/**", "obj/**", "_site/**" ] diff --git a/submodules/openiddict-core b/submodules/openiddict-core new file mode 160000 index 0000000..5a6417f --- /dev/null +++ b/submodules/openiddict-core @@ -0,0 +1 @@ +Subproject commit 5a6417f756ca3421a90827dbab9011ca6015ef7a diff --git a/toc.yml b/toc.yml index 1a11cdb..dc33082 100644 --- a/toc.yml +++ b/toc.yml @@ -5,4 +5,7 @@ href: configuration/index.md - name: Samples - href: https://github.com/openiddict/openiddict-samples \ No newline at end of file + href: https://github.com/openiddict/openiddict-samples + +- name: API documentation + href: api/ \ No newline at end of file