1
0
mirror of https://github.com/DCC-EX/CommandStation-EX.git synced 2025-02-27 11:06:03 +01:00
CommandStation-EX/.github/workflows/docs.yml

33 lines
950 B
YAML
Raw Normal View History

2025-02-02 23:25:15 +01:00
name: Docs
on:
push:
branches: [ master-exraildoc ]
2025-02-04 01:19:37 +01:00
pull_request:
branches: [ master ]
workflow_dispatch:
2025-02-02 23:25:15 +01:00
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@v4.1.1
- name: Requirements
2025-02-03 23:29:17 +01:00
# Allow sphinx-rtd-theme to choose the versions of sphinx & docutils
2025-02-02 23:25:15 +01:00
run: |
2025-02-03 23:29:17 +01:00
pip3 install -r requirements.txt
2025-02-02 23:25:15 +01:00
- name: Build docs
run: |
2025-02-04 01:19:37 +01:00
cd docs
2025-02-03 23:31:05 +01:00
make html
2025-02-03 23:29:17 +01:00
echo 'dcc-ex.com' > docs/_build/html/CNAME
touch docs/_build/html/.nojekyll
2025-02-02 23:25:15 +01:00
- name: Deploy
2025-02-03 23:29:17 +01:00
if: github.ref == 'refs/heads/sphinx'
uses: JamesIves/github-pages-deploy-action@ba1486788b0490a235422264426c45848eac35c6 # v4.4.1
2025-02-02 23:25:15 +01:00
with:
token: ${{ secrets.GITHUB_TOKEN }}
branch: gh-pages # The branch the action should deploy to.
folder: docs/_build/html # The folder the action should deploy.