From bf931993143ae3b016b74fd5407bdd7d9521e2b3 Mon Sep 17 00:00:00 2001
From: James Graham <j.graham@soton.ac.uk>
Date: Sat, 27 Mar 2021 13:22:09 +0000
Subject: [PATCH] ci: add gh-pages build job for docs
---
.github/workflows/gh-pages.yml | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 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..fd73fa6
--- /dev/null
+++ b/.github/workflows/gh-pages.yml
@@ -0,0 +1,34 @@
+name: github pages
+
+on:
+ push:
+ branches:
+ - pydoc # Set a branch to deploy
+
+jobs:
+ deploy:
+ runs-on: ubuntu-18.04
+ steps:
+ - uses: actions/checkout@v2
+ with:
+ submodules: true # Fetch Hugo themes (true OR recursive)
+ fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
+
+ - name: Set up Python
+ uses: actions/setup-python@v2
+ with:
+ python-version: 3.8
+
+ - name: Install dependencies
+ run: |
+ python -m pip install --upgrade pip
+ pip install pydoc-markdown~=3.10.0
+
+ - name: Build
+ run: pydoc-markdown --build --site-dir public
+
+ - name: Deploy
+ uses: peaceiris/actions-gh-pages@v3
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: ./public
--
GitLab