diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json new file mode 100644 index 0000000..a0acf25 --- /dev/null +++ b/.config/dotnet-tools.json @@ -0,0 +1,12 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "docfx": { + "version": "2.73.0", + "commands": [ + "docfx" + ] + } + } +} \ No newline at end of file diff --git a/Makefile b/Makefile index 49158fd..9573ba6 100644 --- a/Makefile +++ b/Makefile @@ -30,3 +30,7 @@ package/build: plugins/build: make -C Plugins/CoreBluetoothForUnity dylib make -C Plugins/CoreBluetoothForUnity framework + +.PHONY: docs/clean +docs/clean: + rm -rf ./docs/_site diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..2781f6d --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1,9 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_site diff --git a/docs/api/.gitignore b/docs/api/.gitignore new file mode 100644 index 0000000..f798527 --- /dev/null +++ b/docs/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/docs/docfx.json b/docs/docfx.json new file mode 100644 index 0000000..2f32516 --- /dev/null +++ b/docs/docfx.json @@ -0,0 +1,66 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "Packages/com.teach310.core-bluetooth-for-unity/Runtime/**/*.cs" + ], + "exclude": [ + "Packages/com.teach310.core-bluetooth-for-unity/Runtime/Initializer.cs", + "Packages/com.teach310.core-bluetooth-for-unity/Runtime/NativeCallbacks/*.cs" + ], + "src": ".." + } + ], + "dest": "api", + "outputFormat": "mref", + "includePrivateMembers": false, + "disableGitFeatures": false, + "disableDefaultFilter": false, + "filter": "filterConfig.yml", + "noRestore": false, + "namespaceLayout": "flattened", + "memberLayout": "samePage", + "enumSortOrder": "declaringOrder", + "allowCompilationErrors": false + } + ], + "build": { + "content": [ + { + "files": [ + "api/**.yml" + ] + }, + { + "files": [ + "toc.yml", + "*.md" + ] + } + ], + "resource": [ + { + "files": [ + "images/**" + ] + } + ], + "output": "_site", + "globalMetadata": { + "_appTitle": "CoreBluetoothForUnity", + "_appName": "CoreBluetoothForUnity", + "_enableSearch": true, + "_enableNewTab": true + }, + "fileMetadataFiles": [], + "template": [ + "default", + "modern" + ], + "postProcessors": [], + "keepFileLink": false, + "disableGitFeatures": false + } +} \ No newline at end of file diff --git a/docs/filterConfig.yml b/docs/filterConfig.yml new file mode 100644 index 0000000..dd2f58b --- /dev/null +++ b/docs/filterConfig.yml @@ -0,0 +1,7 @@ +apiRules: +- exclude: + uidRegex: ^System\.Object + type: Type +- exclude: + uidRegex: ^CoreBluetooth\.Foundation + type: Namespace diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..30e2b68 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,5 @@ +# CoreBluetoothForUnity + +Provides native Apple CoreBluetooth integration for use with Unity. + +https://github.com/teach310/CoreBluetoothForUnity diff --git a/docs/toc.yml b/docs/toc.yml new file mode 100644 index 0000000..8407e0e --- /dev/null +++ b/docs/toc.yml @@ -0,0 +1,6 @@ +- name: Api Documentation + href: api/ + homepage: api/CoreBluetooth.yml + +- name: Repository + href: https://github.com/teach310/CoreBluetoothForUnity