Merge pull request #10 from dcronqvist/add-docs

Add docs

Author: dcronqvist

.editorconfig

@@ -5,4 +5,11 @@ charset = utf-8
 end_of_line = lf
 indent_size = 2
 indent_style = space
-insert_final_newline = true
+insert_final_newline = true
+
+[.github/**/*.yml]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true

.github/workflows/deploy-docs.yml

@@ -0,0 +1,41 @@
+on:
+  push:
+    branches:
+      - master
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  actions: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy-docs:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup .NET
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: 8.0.x
+      - name: Setup DocFX
+        run: dotnet tool update -g docfx
+      - name: Build docs
+        run: make docs-build
+      - name: Upload docs
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_site
+      - name: Deploy docs
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/tests.yml

@@ -5,7 +5,7 @@ on:
       - dev
 
 jobs:
-  build:
+  tests:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -14,9 +14,9 @@ jobs:
       with:
         dotnet-version: 8.0.x
     - name: Restore dependencies
-      run: dotnet restore
+      run: dotnet restore src/DotTiled.sln
     - name: Build
-      run: dotnet build --no-restore
+      run: dotnet build --no-restore src/DotTiled.sln
     - name: Test
-      run: dotnet test --no-build --verbosity normal
+      run: dotnet test --no-build --verbosity normal src/DotTiled.sln
 

.gitignore

@@ -3,6 +3,11 @@
 ##
 ## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore
 
+# Generated docs
+docs/_site/
+docs/api/
+docs/index.md
+
 # User-specific files
 *.rsuser
 *.suo

DotTiled/Model/Layers/Objects/PointObject.cs

@@ -1,5 +1,12 @@
 test:
-	dotnet test
+	dotnet test src/DotTiled.sln
+
+docs-serve: docs-build
+	docfx docs/docfx.json --serve
+
+docs-build:
+	cp README.md docs/index.md
+	docfx docs/docfx.json
 
 BENCHMARK_SOURCES = DotTiled.Benchmark/Program.cs DotTiled.Benchmark/DotTiled.Benchmark.csproj
 BENCHMARK_OUTPUTDIR = DotTiled.Benchmark/BenchmarkDotNet.Artifacts

DotTiled/Serialization/Tmj/Tmj.Wangset.cs

@@ -0,0 +1,46 @@
+{
+  "metadata": [
+    {
+      "src": [
+        {
+          "src": "../src",
+          "files": [
+            "DotTiled/DotTiled.csproj"
+          ]
+        }
+      ],
+      "dest": "api"
+    }
+  ],
+  "build": {
+    "content": [
+      {
+        "files": [
+          "**/*.{md,yml}"
+        ],
+        "exclude": [
+          "_site/**"
+        ]
+      }
+    ],
+    "resource": [
+      {
+        "files": [
+          "images/**"
+        ]
+      }
+    ],
+    "output": "_site",
+    "template": [
+      "default",
+      "modern",
+      "template"
+    ],
+    "globalMetadata": {
+      "_appName": "DotTiled",
+      "_appTitle": "DotTiled",
+      "_enableSearch": true,
+      "pdf": true
+    }
+  }
+}