diff --git a/docfx.json b/docfx.json new file mode 100644 index 0000000..0706245 --- /dev/null +++ b/docfx.json @@ -0,0 +1,42 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ "**/*.sln" ], + "exclude": [ "**/bin/**", "**/obj/**" ], + "src": "." + } + ], + "dest": "obj/api", + "filter": "filter.yml", + "properties": { "TargetFramework": "net8" } + } + ], + "build": { + "content": [ + { + "files": [ "**/*.yml" ], + "src": "obj/api", + "dest": "api" + }, + { + "files": [ "*.md", "toc.yml" ] + } + ], + "globalMetadata": { + "_appTitle": "LinksPlatform's Platform.Disposables Library", + "_enableSearch": true, + "_gitContribute": { + "branch": "main" + }, + "_gitUrlPattern": "github" + }, + "markdownEngineName": "markdig", + "dest": "_site", + "xrefService": [ + "https://xref.docs.microsoft.com/query?uid={uid}", + "https://linksplatform.github.io/Exceptions/csharp/xrefmap.yml" + ] + } +} \ No newline at end of file diff --git a/filter.yml b/filter.yml new file mode 100644 index 0000000..d4f93f7 --- /dev/null +++ b/filter.yml @@ -0,0 +1,5 @@ +apiRules: +- exclude: + uidRegex: (Tests|Benchmarks)(\.[A-Za-z]+)?$ +- exclude: + uidRegex: CSharpToCppTranslator$ \ No newline at end of file diff --git a/toc.yml b/toc.yml new file mode 100644 index 0000000..60cec62 --- /dev/null +++ b/toc.yml @@ -0,0 +1,5 @@ +- name: Home + href: README.md +- name: API Documentation + href: obj/api/ + homepage: api/Platform.Disposables.html \ No newline at end of file