Skip to content

Commit

Permalink
Add API docs for MAUI (#285)
Browse files Browse the repository at this point in the history
  • Loading branch information
frederikprijck authored Oct 11, 2023
1 parent 2bd7924 commit ebdcd60
Show file tree
Hide file tree
Showing 14 changed files with 171 additions and 6 deletions.
4 changes: 3 additions & 1 deletion docs-source/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@
- name: WinForms
href: winforms/api/Auth0.OidcClient.html
- name: UWP
href: uwp/api/Auth0.OidcClient.html
href: uwp/api/Auth0.OidcClient.html
- name: MAUI
href: maui/api/Auth0.OidcClient.html
4 changes: 3 additions & 1 deletion src/Auth0.OidcClient.Android/docs-source/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@
- name: WinForms
href: ../winforms/api/Auth0.OidcClient.html
- name: UWP
href: ../uwp/api/Auth0.OidcClient.html
href: ../uwp/api/Auth0.OidcClient.html
- name: MAUI
href: ../maui/api/Auth0.OidcClient.html
6 changes: 4 additions & 2 deletions src/Auth0.OidcClient.MAUI/Auth0.OidcClient.MAUI.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,10 @@
<TargetPlatformMinVersion Condition="$([MSBuild]::GetTargetPlatformIdentifier('$(TargetFramework)')) == 'windows'">10.0.17763.0</TargetPlatformMinVersion>

<PackageReadmeFile>README.md</PackageReadmeFile>

<PackageId>Auth0.OidcClient.MAUI</PackageId>
<RootNamespace>Auth0.OidcClient</RootNamespace>
<AssemblyName>Auth0.OidcClient</AssemblyName>
<Product>Auth0.OidcClient</Product>
<AssemblyTitle>Auth0.OidcClient.MAUI</AssemblyTitle>
<Version>1.0.0-beta.0</Version>
<Description>Auth0 OIDC Client for MAUI apps</Description>
<Authors>Auth0</Authors>
Expand Down
65 changes: 65 additions & 0 deletions src/Auth0.OidcClient.MAUI/docs-source/docfx.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"metadata": [
{
"src": [
{
"files": [
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
}
],
"dest": "api",
"filter": "filter.yml",
"includePrivateMembers": false,
"disableGitFeatures": false,
"disableDefaultFilter": false,
"noRestore": false,
"namespaceLayout": "flattened",
"memberLayout": "samePage",
"EnumSortOrder": "alphabetic",
"allowCompilationErrors": false,
"references": [
{
"files": [
"bin/Release/**/mscorlib.dll",
"bin/Release/**/System*.dll"
],
"cwd": "../"
}
]

}
],
"build": {
"content": [
{
"files": [ "**/*.{md,yml}" ],
"exclude": [ "_site/**", "obj/**" ]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"output": "_site",
"globalMetadata": {
"_appLogoUrl": "/auth0-oidc-client-net",
"_appLogoPath": "images/logo.png"
},
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default",
"modern",
"../../../docs-source/custom-template"
],
"postProcessors": [],
"keepFileLink": false,
"disableGitFeatures": false
}
}
65 changes: 65 additions & 0 deletions src/Auth0.OidcClient.MAUI/docs-source/docfx.local.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
{
"metadata": [
{
"src": [
{
"files": [
"bin/Release/**/Auth0.OidcClient.dll",
"bin/Release/**/Auth0.OidcClient.Core.dll"
],
"cwd": "../"
}
],
"dest": "api",
"filter": "filter.yml",
"includePrivateMembers": false,
"disableGitFeatures": false,
"disableDefaultFilter": false,
"noRestore": false,
"namespaceLayout": "flattened",
"memberLayout": "samePage",
"EnumSortOrder": "alphabetic",
"allowCompilationErrors": false,
"references": [
{
"files": [
"bin/Release/**/mscorlib.dll",
"bin/Release/**/System*.dll"
],
"cwd": "../"
}
]

}
],
"build": {
"content": [
{
"files": [ "**/*.{md,yml}" ],
"exclude": [ "_site/**", "obj/**" ]
}
],
"resource": [
{
"files": [
"images/**"
]
}
],
"output": "_site",
"globalMetadata": {
"_appLogoUrl": "/",
"_appLogoPath": "images/logo.png"
},
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"template": [
"default",
"modern",
"../../../docs-source/custom-template"
],
"postProcessors": [],
"keepFileLink": false,
"disableGitFeatures": false
}
}
3 changes: 3 additions & 0 deletions src/Auth0.OidcClient.MAUI/docs-source/filter.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
apiRules:
- exclude:
uidRegex: "^Auth0.OidcClient.Resource"
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions src/Auth0.OidcClient.MAUI/docs-source/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
- name: Documentation
href: ../
- name: Android
href: ../android/api/Auth0.OidcClient.html
- name: iOS
href: ../ios/api/Auth0.OidcClient.html
- name: WPF
href: ../wpf/api/Auth0.OidcClient.html
- name: WinForms
href: ../winforms/api/Auth0.OidcClient.html
- name: UWP
href: ../uwp/api/Auth0.OidcClient.html
- name: MAUI
href: ../maui/api/Auth0.OidcClient.html
2 changes: 2 additions & 0 deletions src/Auth0.OidcClient.UWP/docs-source/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
href: ../winforms/api/Auth0.OidcClient.html
- name: UWP
href: ../uwp/api/Auth0.OidcClient.html
- name: MAUI
href: ../maui/api/Auth0.OidcClient.html
2 changes: 2 additions & 0 deletions src/Auth0.OidcClient.WPF/docs-source/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
href: ../winforms/api/Auth0.OidcClient.html
- name: UWP
href: ../uwp/api/Auth0.OidcClient.html
- name: MAUI
href: ../maui/api/Auth0.OidcClient.html
2 changes: 2 additions & 0 deletions src/Auth0.OidcClient.WinForms/docs-source/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
href: ../winforms/api/Auth0.OidcClient.html
- name: UWP
href: ../uwp/api/Auth0.OidcClient.html
- name: MAUI
href: ../maui/api/Auth0.OidcClient.html
2 changes: 2 additions & 0 deletions src/Auth0.OidcClient.iOS/docs-source/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,5 @@
href: ../winforms/api/Auth0.OidcClient.html
- name: UWP
href: ../uwp/api/Auth0.OidcClient.html
- name: MAUI
href: ../maui/api/Auth0.OidcClient.html
4 changes: 3 additions & 1 deletion tools/build-docs-local.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ docfx src/Auth0.OidcClient.iOS/docs-source/docfx.local.json
docfx src/Auth0.OidcClient.WPF/docs-source/docfx.local.json
docfx src/Auth0.OidcClient.WinForms/docs-source/docfx.local.json
docfx src/Auth0.OidcClient.UWP/docs-source/docfx.local.json
docfx src/Auth0.OidcClient.MAUI/docs-source/docfx.local.json
# Create root docs
docfx docs-source/docfx.json

mv src/Auth0.OidcClient.Android/docs-source/_site docs/android
mv src/Auth0.OidcClient.iOS/docs-source/_site docs/ios
mv src/Auth0.OidcClient.WPF/docs-source/_site docs/wpf
mv src/Auth0.OidcClient.WinForms/docs-source/_site docs/winforms
mv src/Auth0.OidcClient.UWP/docs-source/_site docs/uwp
mv src/Auth0.OidcClient.UWP/docs-source/_site docs/uwp
mv src/Auth0.OidcClient.MAUI/docs-source/_site docs/maui
4 changes: 3 additions & 1 deletion tools/build-docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,13 @@ docfx src/Auth0.OidcClient.iOS/docs-source/docfx.json
docfx src/Auth0.OidcClient.WPF/docs-source/docfx.json
docfx src/Auth0.OidcClient.WinForms/docs-source/docfx.json
docfx src/Auth0.OidcClient.UWP/docs-source/docfx.json
docfx src/Auth0.OidcClient.MAUI/docs-source/docfx.json
# Create root docs
docfx docs-source/docfx.json

mv src/Auth0.OidcClient.Android/docs-source/_site docs/android
mv src/Auth0.OidcClient.iOS/docs-source/_site docs/ios
mv src/Auth0.OidcClient.WPF/docs-source/_site docs/wpf
mv src/Auth0.OidcClient.WinForms/docs-source/_site docs/winforms
mv src/Auth0.OidcClient.UWP/docs-source/_site docs/uwp
mv src/Auth0.OidcClient.UWP/docs-source/_site docs/uwp
mv src/Auth0.OidcClient.MAUI/docs-source/_site docs/maui

0 comments on commit ebdcd60

Please sign in to comment.