From 02d17e52c197eb4ca6bd869dd9b63d1684b90773 Mon Sep 17 00:00:00 2001 From: Jamie Lentin Date: Thu, 5 Feb 2026 21:54:48 +0000 Subject: [PATCH] .github/workflows: Documentation-generation workflow Add a workflow to generate and publish the ne documentation. --- .github/workflows/gh-pages.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 .github/workflows/gh-pages.yml diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml new file mode 100644 index 0000000..3f69e3c --- /dev/null +++ b/.github/workflows/gh-pages.yml @@ -0,0 +1,32 @@ +on: + push: + branches: + - master + workflow_dispatch: + +name: Render documentation + +jobs: + documentation: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v6 + + - name: Install build-prerequisites + run: sudo apt install --no-install-recommends build-essential libncurses-dev perl texinfo texlive-latex-base texlive-fonts-recommended + + - name: Build HTML docs + run: make -C doc html/index.html + + - name: Build PDF docs + run: make -C doc ne.pdf + + - name: Copy parts to deploy dir + run: mkdir gh-pages && cp -r doc/html gh-pages/docs && cp -r doc/ne.pdf gh-pages/ + + - name: Deploy to gh-pages + uses: peaceiris/actions-gh-pages@v4 + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./gh-pages/ + destination_dir: ./