Merge pull request #99 from janspeller/feature/gh-pages

Move to Github Pages for Documentation Deployment
This commit is contained in:
Bastian Schroll 2022-05-24 10:28:12 +02:00 committed by GitHub
commit 790b944200
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 18 additions and 18 deletions

View file

@ -3,17 +3,27 @@ name: build_docs
on:
push:
branches:
- master
# - master
- develop
jobs:
build_docs:
name: Build documentation
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.10']
steps:
- name: Checkout
uses: actions/checkout@v1
uses: actions/checkout@v2
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
architecture: x64
- name: Build doxygen
uses: mattnotmitt/doxygen-action@v1
@ -21,19 +31,7 @@ jobs:
working-directory: './'
doxyfile-path: 'docu/doxygen.ini'
- name: Build mkdocs
run: |
python -m pip install --upgrade pip
pip install mkdocs
python -m mkdocs build -f docu/mkdocs.yml
- name: Upload to docs-server
uses: appleboy/scp-action@master
with:
host: ${{ secrets.SCP_HOST }}
port: ${{ secrets.SCP_PORT }}
username: ${{ secrets.SCP_USERNAME }}
password: ${{ secrets.SCP_PASSWORD }}
source: "docu/site/**"
target: ${{ secrets.SCP_TARGET_PATH }}
strip_components: 2
- name: Install mkdocs
run: pip install mkdocs
- name: Build Docs and Deploy to Github Pages
run: python -m mkdocs gh-deploy -f docu/mkdocs.yml --force

View file

@ -26,6 +26,8 @@ nav:
- Plugins:
- Http: plugin/http.md
- Telegram: plugin/telegram.md
- Divera: plugin/divera.md
- MySQL: plugin/mysql.md
- Entwickler:
- Eigenes Modul/Plugin schreiben: develop/ModulPlugin.md
- BOSWatch Alarmpaket Format: develop/packet.md