Skip to content

Commit

Permalink
Fix docs build
Browse files Browse the repository at this point in the history
  • Loading branch information
DRSchlaubi committed Jun 30, 2024
1 parent daabd5d commit f0fe442
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 81 deletions.
89 changes: 10 additions & 79 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -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 }}
6 changes: 5 additions & 1 deletion docs/buildprofiles.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@
<variables>
<enable-browser-edits>true</enable-browser-edits>
<browser-edits-url>https://github.com/kordlib/codegen-kt/edit/main/docs/</browser-edits-url>

<algolia-id>JYGRRNLGJT</algolia-id>
<algolia-index>codegen_kt_wiki</algolia-index>
<algolia-api-key>5923511b60eb8db61a58902f9d3d4cc4</algolia-api-key>
</variables>
<build-profile instance="codegen.kt"/>
<footer>
<copyright>Kord Team 2019-2023</copyright>
<copyright>Kord Team 2019-2024</copyright>
<link href="https://github.com/kordlib">GitHub</link>
</footer>
</buildprofiles>
2 changes: 1 addition & 1 deletion docs/topics/Annotation-Argument-Processor.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
Empty file modified gradlew
100644 → 100755
Empty file.

0 comments on commit f0fe442

Please sign in to comment.