Skip to content

Commit

Permalink
chore: attempt to fix docs building from CI
Browse files Browse the repository at this point in the history
  • Loading branch information
copernico authored Sep 11, 2020
2 parents 4ac1a8c + ef16b8f commit db61fcf
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 28 deletions.
46 changes: 27 additions & 19 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,27 +1,35 @@
name: Build Docs

# Controls when the action will run. Triggers the workflow on push or pull request
# events but only for the master branch
name: build and deploy mkdocs to github pages
on:
push:
branches: [master]
branches:
- master
pull_request:
branches: [master]
branches:
- master

jobs:
build:
name: Build and Deploy Documentation
deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout Master
uses: actions/checkout@v2

- name: Install setuptools
run: apt-get install python3-setuptools

- name: Install Material
run: python3 -m pip install mkdocs-material
- uses: actions/checkout@v2

- name: Setup Python
uses: actions/setup-python@v1
with:
python-version: '3.7'
architecture: 'x64'

- name: Install dependencies
run: |
python3 -m pip install --upgrade pip # install pip
python3 -m pip install mkdocs # install mkdocs
python3 -m pip install mkdocs-material # install material theme
- name: Build site
run: mkdocs build

- name: Build and Deploy Documentation using MkDocs
uses: Tangerine-Community/tangy-mkdocs-build-action@v1
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/public
Empty file added docs/public/.gitkeep
Empty file.
18 changes: 9 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@ extra:
# - type: 'linkedin'
# link: 'https://linkedin.com/in/squidfunk'

theme:
name: 'material'
palette:
primary: 'green'
accent: 'green'
logo:
icon: 'cloud'
feature:
tabs: false
# theme:
# name: 'material'
# palette:
# primary: 'green'
# accent: 'green'
# logo:
# icon: 'cloud'
# feature:
# tabs: false

extra_css:
- css/faq.css

0 comments on commit db61fcf

Please sign in to comment.