Merge pull request #462 from pinout-xyz/patch-github-pages

CI: Publish to GitHub pages.

.github/workflows/pages.yml

@@ -0,0 +1,35 @@
+name: Pages
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  test:
+    name: GitHub Pages (en)
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.11
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.11
+
+      - name: Install Dependencies
+        run: |
+          make deps
+
+      - name: Build Packages
+        run: |
+          make LANG=en
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+            github_token: ${{ secrets.GITHUB_TOKEN }}
+            publish_dir: ./output/en
+            cname: pinout.xyz

Makefile

@@ -8,6 +8,9 @@ LANG := $(firstword $(LANG))
 
 all: html resources
 
+deps:
+	python3 -m pip install -r requirements.txt
+
 css:
 	scss resources/pinout.scss > resources/pinout.scss.css
 

generate-html.py

@@ -1,4 +1,4 @@
-#!/usr/bin/env python
+#!/usr/bin/env python3
 
 import os
 import re
@@ -787,9 +787,14 @@ def interfaces_menu(current):
                                   crumbtrail=crumbtrail
                                   )
 
-    debug(0, '>> Saving: pinout/{}.html'.format(pin_url))
+    debug(0, '>> Saving: pinout/{}/index.html'.format(pin_url))
 
-    with open(os.path.join('output', lang, 'pinout', '{}.html'.format(pin_url)), 'w') as f:
+    try:
+        os.mkdir(os.path.join('output', lang, 'pinout', '{}'.format(pin_url)))
+    except FileExistsError:
+        pass
+
+    with open(os.path.join('output', lang, 'pinout', '{}/index.html'.format(pin_url)), 'w') as f:
         f.write(pin_html)
 
 
@@ -876,10 +881,21 @@ def interfaces_menu(current):
     if url not in ['index', '404', 'boards']:
         url = os.path.join('pinout', url)
 
+    output_path = os.path.join('output', lang, f'{url}.html')
+    output_url = f'{url}.html'
+
+    if url == 'boards':
+        output_path = os.path.join('output', lang, f'{url}/index.html')
+        output_url = f'{url}/index.html'
+        try:
+            os.mkdir(os.path.join('output', lang, url))
+        except FileExistsError:
+            pass
+
     if 'source' in pages[key]:
-        debug(0, '>> Saving: {src} => {url}.html'.format(url=url, src=pages[key]['source']))
+        debug(0, '>> Saving: {src} => {url}'.format(url=output_url, src=pages[key]['source']))
 
-    with open(os.path.join('output', lang, '{}.html'.format(url)), 'w') as f:
+    with open(output_path, 'w') as f:
         f.write(html)
 
 print('\nAll done!')

src/en/template/footer.html

@@ -1,3 +1,3 @@
 <p>Spotted an error, want to add your board's pinout? <a href="https://github.com/pinout-xyz/Pinout.xyz">Contribute to Pinout.xyz at GitHub</a></p>
-<p>Originally part of <a href="http://pi.gadgetoid.com">pi.gadgetoid.com</a>. Maintained by <a href="https://fosstodon.org/@gadgetoid">@[email protected]</a>.</p>
+<p>Part of <a href="https://www.gadgetoid.com">gadgetoid.com</a>. Maintained by <a href="https://fosstodon.org/@gadgetoid">@[email protected]</a>.</p>
 <p>Help make Pinout.xyz better- please sponsor me at <a href="https://ko-fi.com/gadgetoid">Ko-Fi</a>, <a href="https://github.com/sponsors/Gadgetoid">GitHub</a> or <a href="https://www.patreon.com/gadgetoid">Patreon</a></p>