docs: API docs generation (#79)

* adding api docs project structure

* fix path for source projects

* updated github actions to publish api docs

.github/workflows/docs.yml

@@ -27,4 +27,11 @@ jobs:
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./dist
+          publish_dir: ./dist
+      - name: Release API docs to latest
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./apidocs/_site
+          keep_files: true
+          destination_dir: latest/api

.gitignore

@@ -2,6 +2,9 @@ docs/node_modules
 docs/.cache
 docs/public
 
+apidocs/_site
+apidocs/obj
+
 deploy/**
 
 .idea

apidocs/api/.gitignore

@@ -0,0 +1,5 @@
+###############
+#  temp file  #
+###############
+*.yml
+.manifest

apidocs/docfx.json

@@ -0,0 +1,71 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "files": [
+            "**/*.csproj"
+          ],
+          "src": "../libraries/src/",
+          "force": true
+        }
+      ],
+      "dest": "api",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": "_site",
+    "globalMetadataFiles": [],
+    "globalMetadata": {
+      "_appTitle": "AWS Lambda Powertools for .NET",
+      "_appFaviconPath": "images/favicon.ico",
+      "_appLogoPath": "images/AWS_logo.png",
+      "_enableNewTab": true,
+      "_disableContribution": true
+    },
+    "fileMetadataFiles": [],
+    "template": [
+      "default"
+    ],
+    "postProcessors": [],
+    "markdownEngineName": "markdig",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
+}

apidocs/index.md

@@ -0,0 +1,15 @@
+# AWS Lambda Powertools for .NET API
+
+Welcome to the *AWS Lambda Powertools for .NET* API reference. This documentation contains the API details for all supported utilities.
+
+If you have any feedback, create a new issue in the *AWS Lambda Powertools for .NET* repository on GitHub.
+
+### API reference
+
+[AWS.Lambda.Powertools.Common](api/AWS.Lambda.Powertools.Common.html)
+
+[AWS.Lambda.Powertools.Metrics](api/AWS.Lambda.Powertools.Metrics.html)
+
+[AWS.Lambda.Powertools.Tracing](api/AWS.Lambda.Powertools.Tracing.html)
+
+[AWS.Lambda.Powertools.Logging](api/AWS.Lambda.Powertools.Logging.html)

apidocs/toc.yml

@@ -0,0 +1,3 @@
+- name: API
+  href: api/
+  homepage: api/index.md