Skip to content

Commit

Permalink
Merge pull request #42 from SmithChart/master
Browse files Browse the repository at this point in the history
Deploy doc to Github Pages
  • Loading branch information
SmithChart committed Apr 28, 2023
2 parents adcf2d1 + e263b0d commit e434953
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 4 deletions.
51 changes: 51 additions & 0 deletions .github/workflows/main.yml
@@ -0,0 +1,51 @@
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Deploy Jekyll with GitHub Pages dependencies preinstalled

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Build
run: git fetch -a && cd doc && make html
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: doc/output/

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2

4 changes: 1 addition & 3 deletions doc/content/index.rst
Expand Up @@ -95,8 +95,6 @@ If you have problems or suggestions, don't hesitate to ask for help!

Issue tracker: [`link <http://www.github.com/pengutronix/flamingo/issues>`__]

Pengutronix email: [`entwicklung@pengutronix.de <entwicklung@pengutronix.de>`__]

Maintainer email: [`f.scherf@pengutronix.de <f.scherf@pengutronix.de>`__]
Email: [`entwicklung@pengutronix.de <entwicklung@pengutronix.de>`__]

Send patches: [`link <http://www.github.com/pengutronix/flamingo/>`__]
1 change: 0 additions & 1 deletion doc/settings.py
Expand Up @@ -22,7 +22,6 @@

# sphinx theme
SPHINX_THEMES_HTML_THEME = 'sphinx_rtd_theme'
SPHINX_THEMES_LOGO = True
SPHINX_THEMES_LOGO_URL = '/static/flamingo.svg'
SPHINX_THEMES_DOCSTITLE = 'Flamingo'
SPHINX_THEMES_SHORTTITLE = 'Flamingo'
Expand Down

0 comments on commit e434953

Please sign in to comment.