From f0fe4422c0292e765507269037da31e3b1b41364 Mon Sep 17 00:00:00 2001 From: Michael Rittmeister Date: Sun, 30 Jun 2024 23:32:04 +0200 Subject: [PATCH] Fix docs build --- .github/workflows/docs.yml | 89 +++----------------- docs/buildprofiles.xml | 6 +- docs/topics/Annotation-Argument-Processor.md | 2 +- gradlew | 0 4 files changed, 16 insertions(+), 81 deletions(-) mode change 100644 => 100755 gradlew diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index d4f73cb..d9112ad 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,88 +1,19 @@ -name: Build docs - +name: Documentation CI on: push: branches: [ "main" ] -# Gives the workflow permissions to clone the repo and create a page deployment permissions: id-token: write pages: write -env: - PRODUCT: docs/c - DOC_ARTIFACT: webHelpC2-all.zip - ALGOLIA_ARTIFACT: algolia-indexes-XX.zip - jobs: - build-dokka: - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - name: Setup JDK - uses: actions/setup-java@v3 - with: - distribution: "temurin" - java-version: "11" - - name: Build Dokka - uses: gradle/gradle-build-action@v2 - with: - arguments: :dokkaHtmlMultiModule - - name: Upload documentation - uses: actions/upload-artifact@v3 - with: - name: dokka - path: docs/api - retention-days: 7 - build-writerside: - runs-on: ubuntu-latest - steps: - - name: Checkout repository - uses: actions/checkout@v4 - - name: Build Writerside docs using Docker - uses: JetBrains/writerside-github-action@v3 - - name: Upload documentation - uses: actions/upload-artifact@v3 - with: - name: help - path: artifacts/${{ env.DOC_ARTIFACT }} - retention-days: 7 - # # Add the step below to upload Algolia indexes - # - name: Upload algolia-indexes - # uses: actions/upload-artifact@v3 - # with: - # name: algolia-indexes - # path: artifacts/${{ env.ALGOLIA_ARTIFACT }} - # retention-days: 7 - - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - # Requires the build-job results - needs: [build-writerside, build-dokka] - runs-on: ubuntu-latest - steps: - - name: Download webhelp - uses: actions/download-artifact@v3 - with: - name: help - - name: Download dokka - uses: actions/download-artifact@v3 - with: - name: dokka - path: dir/api - - name: Unzip artifact - uses: montudor/action-zip@v1 - with: - args: unzip -qq ${{ env.DOC_ARTIFACT }} -d dir - - name: Setup Pages - uses: actions/configure-pages@v2 - - name: Upload artifact - uses: actions/upload-pages-artifact@v1 - with: - path: dir - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v1 + docs: + uses: kordlib/.teamcity/.github/workflows/wiki.yml@main + with: + build-dokka: true + path: docs/c + product: C + algolia-index: codegen_kt_wiki + version: main-SNAPSHOT + algolia-token: ${{ secrets.ALGOLIA_KEY }} diff --git a/docs/buildprofiles.xml b/docs/buildprofiles.xml index f207903..e99d7dc 100644 --- a/docs/buildprofiles.xml +++ b/docs/buildprofiles.xml @@ -3,10 +3,14 @@ true https://github.com/kordlib/codegen-kt/edit/main/docs/ + + JYGRRNLGJT + codegen_kt_wiki + 5923511b60eb8db61a58902f9d3d4cc4 diff --git a/docs/topics/Annotation-Argument-Processor.md b/docs/topics/Annotation-Argument-Processor.md index fc03160..218a9a9 100644 --- a/docs/topics/Annotation-Argument-Processor.md +++ b/docs/topics/Annotation-Argument-Processor.md @@ -1,6 +1,6 @@ # Annotation Argument Processor -Even though the [Annotation Argument API](Annotation-Argument-Processor.md) provides an easier to use API than the +Even though the Annotation Argument API provides an easier to use API than the default KSP API, it can still require some boiler-plate to setup. For this reason an annotation processor is provided to generate that boiler plate for you diff --git a/gradlew b/gradlew old mode 100644 new mode 100755