From bcb2c1782587963a5e47ba4d1c40937f31bd192e Mon Sep 17 00:00:00 2001 From: Ixzu-12 Date: Thu, 29 Oct 2026 10:52:04 +0000 Subject: [PATCH 1/2] docs: publish split HTML manual with GitHub Pages --- .github/workflows/docs.yml | 94 ++++++++++++++++++++++++++++++++++++++ docs/Makefile.am | 2 +- 2 files changed, 95 insertions(+), 1 deletion(-) create mode 100755 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100755 index 0000000..eca86f9 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,94 @@ + +name: Documentation + +on: + push: + branches: [main] + paths: + - "docs/**" + - ".github/workflows/docs.yml" + - "configure.ac" + - "Makefile.am" + - "Makefile.in" + - "bootstrap" + - "llms.txt" + pull_request: + branches: [main] + paths: + - "docs/**" + - ".github/workflows/docs.yml" + - "configure.ac" + - "Makefile.am" + - "Makefile.in" + - "bootstrap" + - "llms.txt" + workflow_dispatch: + +permissions: + contents: read + +concurrency: + group: docs-${{ github.ref }} + cancel-in-progress: true + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v4 + + - name: Install build dependencies + run: | + sudo apt-get update + sudo apt-get install -y autoconf automake texinfo + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: "3.12" + + - name: Install configure dependencies + run: | + python -m pip install requests prompt_toolkit + + - name: Configure and build split HTML + run: | + ./bootstrap + ./configure PYTHON="$(command -v python)" + make html + test -f docs/codebud.html/index.html + + - name: Prepare site + run: | + mkdir -p site + cp -a docs/codebud_html/. site/ + cp llms.txt site/llms.txt + touch site/.nojekyll + test -f site/index.html + test -f site/llms.txt + + - name: Upload Pages artifact + if: github.event_name != 'pull_request' + uses: actions/upload-pages-artifact@v4 + with: + path: site + + deploy: + if: github.event_name != 'pull_request' + needs: build + runs-on: ubuntu-latest + permissions: + contents: read + pages: write + id-token: write + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + steps: + - name: Configure GitHub Pages + uses: actions/configure-pages@v5 + + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/docs/Makefile.am b/docs/Makefile.am index 5105379..5f1bfd0 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -22,6 +22,6 @@ codebud_TEXINFOS = \ chapters/troubleshooting.texi \ chapters/usage.texi -AM_MAKEINFOHTMLFLAGS = --no-split +AM_MAKEINFOHTMLFLAGS = --split=node MAINTAINERCLEANFILES = Makefile.in From 7cee3c8862cfc9ca51432f01a3cc3ddecc8c0c5c Mon Sep 17 00:00:00 2001 From: Ixzu-12 Date: Thu, 12 Nov 2026 10:32:02 +0000 Subject: [PATCH 2/2] fix(docs): correct HTML output directory --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index eca86f9..2e78d1f 100755 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -62,7 +62,7 @@ jobs: - name: Prepare site run: | mkdir -p site - cp -a docs/codebud_html/. site/ + cp -a docs/codebud.html/. site/ cp llms.txt site/llms.txt touch site/.nojekyll test -f site/index.html