- replace ReadTheDocs with Github Pages + Writerside

Articus · Mar 10, 2024 · 62fba64 · 62fba64
1 parent 5bb9bff
commit 62fba64
Show file tree

Hide file tree

Showing 10 changed files with 62 additions and 8 deletions.
diff --git a/.github/workflows/publish-docs.yml b/.github/workflows/publish-docs.yml
@@ -0,0 +1,37 @@
+name: Publish docs
+on:
+  push:
+    branches:
+    - master
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  pages: write
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy.outputs.page_url }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Build documentation archive
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: docs/docs
+          artifact: docs.zip
+          docker-version: '233.14389'
+
+      - name: Unpack documentation archive
+        run: unzip ./artefacts/docs.zip -d ./_site
+
+      - name: Upload GitHub Pages artifact with documentation
+        uses: actions/upload-pages-artifact@v3
+
+      - name: Deploy Github Pages site with documentation
+        id: deploy
+        uses: actions/deploy-pages@v4
diff --git a/docs/cfg/buildprofiles.xml b/docs/cfg/buildprofiles.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <build-profile instance="docs">
+        <variables>
+            <noindex-content>false</noindex-content>
+        </variables>
+    </build-profile>
+</buildprofiles>
diff --git a/docs/docs.tree b/docs/docs.tree
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="docs" name="Documentation" start-page="index.md">
+    <toc-element topic="index.md" toc-title="About"/>
+    <toc-element topic="routing.md"/>
+    <toc-element topic="consuming.md"/>
+    <toc-element topic="attributing.md"/>
+    <toc-element topic="producing.md"/>
+</instance-profile>
diff --git a/docs/attributing.md → docs/topics/attributing.md b/docs/attributing.md → docs/topics/attributing.md
diff --git a/docs/consuming.md → docs/topics/consuming.md b/docs/consuming.md → docs/topics/consuming.md
diff --git a/docs/index.md → docs/topics/index.md b/docs/index.md → docs/topics/index.md
diff --git a/docs/producing.md → docs/topics/producing.md b/docs/producing.md → docs/topics/producing.md
diff --git a/docs/routing.md → docs/topics/routing.md b/docs/routing.md → docs/topics/routing.md
diff --git a/docs/writerside.cfg b/docs/writerside.cfg
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE ihp SYSTEM "https://resources.jetbrains.com/writerside/1.0/ihp.dtd">
+
+<ihp version="2.0">
+    <topics dir="topics" web-path="topics"/>
+    <instance src="docs.tree"/>
+</ihp>
diff --git a/mkdocs.yml b/mkdocs.yml