From 2b874934878d82cd161ea36172113cd15dad4eb0 Mon Sep 17 00:00:00 2001 From: Vaxry <43317083+vaxerski@users.noreply.github.com> Date: Sat, 30 Dec 2023 15:15:36 +0100 Subject: [PATCH] CI: deploy docs (#2) --- .github/workflows/arch.yml | 40 ++++++++++++++++++++++++++++++++++++++ README.md | 2 +- hyprlang-docs | 2 +- 3 files changed, 42 insertions(+), 2 deletions(-) diff --git a/.github/workflows/arch.yml b/.github/workflows/arch.yml index 9762991..59d8055 100644 --- a/.github/workflows/arch.yml +++ b/.github/workflows/arch.yml @@ -69,3 +69,43 @@ jobs: - name: Run tests run: | cd ./tests && ../build/hyprlang_test + + doxygen: + name: "Deploy docs" + runs-on: ubuntu-latest + container: + image: archlinux + steps: + - name: Checkout repository actions + uses: actions/checkout@v4 + with: + sparse-checkout: .github/actions + + - name: Get required pkgs + run: | + sed -i 's/SigLevel = Required DatabaseOptional/SigLevel = Optional TrustAll/' /etc/pacman.conf + pacman --noconfirm --noprogressbar -Syyu + pacman --noconfirm --noprogressbar -Sy gcc base-devel cmake clang doxygen git openssh + + - name: Get doxygen theme + run: | + git clone https://github.com/jothepro/doxygen-awesome-css + cd doxygen-awesome-css && git checkout v2.3.1 && cd .. + + - name: Build doxygen site + run: | + doxygen hyprlang-docs + + - name: Deploy + env: + PK: ${{ secrets.UPDATE_DOCS_PK }} + PT: ${{ secrets.DEPLOY_PORT5 }} + AD: ${{ secrets.DEPLOY_USER }} + PH: ${{ secrets.DEPLOY_PATH }} + run: | + echo "$PK" > ./pk + chmod 400 ./pk + eval $(ssh-agent -s) && ssh-add ./pk + scp -O -o "StrictHostKeyChecking=no" -P $PT -r ./doxygen/html/* $AD:.$PH + + diff --git a/README.md b/README.md index 41d2abe..f8a46fe 100644 --- a/README.md +++ b/README.md @@ -50,4 +50,4 @@ add_baker = Koichi, 18, Morioh ## Docs -Soon:tm: +Visit [hyprland.org/hyprlang](https://hyprland.org/hyprlang) to see the documentation. diff --git a/hyprlang-docs b/hyprlang-docs index ca25e89..5a155bb 100644 --- a/hyprlang-docs +++ b/hyprlang-docs @@ -1928,7 +1928,7 @@ EXTRA_SEARCH_MAPPINGS = # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. -GENERATE_LATEX = YES +GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of