API Documentation

FollowingFileStream.APIdoc/.gitignore

@@ -0,0 +1,9 @@
+###############
+#    folder   #
+###############
+/**/DROP/
+/**/TEMP/
+/**/packages/
+/**/bin/
+/**/obj/
+_site

FollowingFileStream.APIdoc/FollowingFileStream.APIdoc.csproj

@@ -0,0 +1,11 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <PreviewOutputFolder>$(MSBuildProjectDirectory)\_site</PreviewOutputFolder>
+    <MetadataOutputFolder>$(MSBuildProjectDirectory)</MetadataOutputFolder>
+    <LogFile>$(MSBuildProjectDirectory)\bin\docfx.log.txt</LogFile>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="docfx.console" Version="2.45.0" PrivateAssets="All"/>
+  </ItemGroup>
+</Project>

FollowingFileStream.APIdoc/api/.gitignore

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

FollowingFileStream.APIdoc/api/index.md

@@ -0,0 +1,2 @@
+# PLACEHOLDER
+TODO: Add .NET projects to the *src* folder and run `docfx` to generate **REAL** *API Documentation*!

FollowingFileStream.APIdoc/articles/intro.md

@@ -0,0 +1 @@
+# Add your introductions here!

FollowingFileStream.APIdoc/articles/toc.yml

@@ -0,0 +1,2 @@
+- name: Introduction
+  href: intro.md

FollowingFileStream.APIdoc/docfx.json

@@ -0,0 +1,69 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../",
+          "files": [
+            "FollowingFileStream/**.cs"
+          ],
+          "exclude": [
+            "**/bin/**",
+            "**/obj/**"
+          ]
+        }
+      ],
+      "dest": "api",
+      "disableGitFeatures": false,
+      "disableDefaultFilter": false
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "api/**.yml",
+          "api/index.md"
+        ]
+      },
+      {
+        "files": [
+          "articles/**.md",
+          "articles/**/toc.yml",
+          "toc.yml",
+          "*.md"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "overwrite": [
+      {
+        "files": [
+          "apidoc/**.md"
+        ],
+        "exclude": [
+          "obj/**",
+          "_site/**"
+        ]
+      }
+    ],
+    "dest": "_site",
+    "globalMetadataFiles": [],
+    "fileMetadataFiles": [],
+    "template": [
+      "default"
+    ],
+    "postProcessors": [],
+    "markdownEngineName": "markdig",
+    "noLangKeyword": false,
+    "keepFileLink": false,
+    "cleanupCacheHistory": false,
+    "disableGitFeatures": false
+  }
+}

FollowingFileStream.APIdoc/index.md

@@ -0,0 +1,4 @@
+# This is the **HOMEPAGE**.
+Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files.
+## Quick Start Notes:
+1. Add images to the *images* folder if the file is referencing an image.

FollowingFileStream.APIdoc/toc.yml

@@ -0,0 +1,5 @@
+- name: Articles
+  href: articles/
+- name: Api Documentation
+  href: api/
+  homepage: api/index.md

README.md

@@ -6,6 +6,8 @@ Any read operation will not report a zero result while the file is locked for wr
 
 It is usually compared to the "tail -f" approach.
 
+[API Documentation](https://followingfilestream.azurewebsites.net/api-doc)
+
 [Source Browser](https://followingfilestream.azurewebsites.net/#FollowingFileStream/)
 
 [![Build Status](https://dev.azure.com/manandre/manandre/_apis/build/status/manandre.FollowingFileStream?branchName=master)](https://dev.azure.com/manandre/manandre/_build/latest?definitionId=1&branchName=master)

azure-pipelines.yml

@@ -147,3 +147,37 @@ jobs:
           PathtoPublish: '$(Build.ArtifactStagingDirectory)/sourcebrowser_website.zip'
           ArtifactName: 'sourcebrowser_website'
           publishLocation: 'Container'
+
+  - job: ApiDoc
+    displayName: API Documentation generation
+    pool:
+        vmImage: 'windows-latest'
+    steps:
+      - task: DotNetCoreCLI@2
+        displayName: Restore
+        inputs:
+          command: 'restore'
+          projects: '**/*.APIdoc.csproj'
+          feedsToUse: 'select'
+
+      - task: DotNetCoreCLI@2
+        displayName: Build
+        inputs:
+          command: 'build'
+          projects: '**/*.APIdoc.csproj'
+          arguments: '--configuration $(BuildConfiguration)'
+
+      - task: ArchiveFiles@2
+        displayName: Zip API documentation website
+        inputs:
+          rootFolderOrFile: '$(Build.SourcesDirectory)/FollowingFileStream.APIdoc/_site'
+          includeRootFolder: false
+          archiveType: 'zip'
+          archiveFile: '$(Build.ArtifactStagingDirectory)/apidoc_website.zip'
+          replaceExistingArchive: true
+
+      - task: PublishBuildArtifacts@1
+        inputs:
+          PathtoPublish: '$(Build.ArtifactStagingDirectory)/apidoc_website.zip'
+          ArtifactName: 'apidoc_website'
+          publishLocation: 'Container'