Skip to content

Documentation updates #434

Documentation updates

Documentation updates #434

Workflow file for this run

name: "Build doc from develop"
#on: [workflow_dispatch, push]
on:
workflow_dispatch:
push:
branches:
- 'develop'
jobs:
build:
runs-on: ubuntu-20.04 #latest
strategy:
fail-fast: false
matrix:
python-version: [ '3.9' ]
name: Python ${{ matrix.python-version }}
steps:
- name: update OS (Ubuntu)
run: sudo apt-get update
- run: sudo apt-get install libudev-dev
- run: sudo apt-get install librrd-dev libpython3-dev
- run: sudo apt-get install gcc --only-upgrade
- uses: actions/checkout@v2
- name: Checkout SmartHomeNG DEVELOP Branch
uses: actions/checkout@v2
with:
repository: smarthomeNG/smarthome
ref: develop
path: smarthomeng
- name: Checkout SmartHomeNG/plugins DEVELOP Branch
uses: actions/checkout@v2
with:
repository: smarthomeNG/plugins
ref: develop
path: smarthomeng/plugins
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
architecture: x64
- name: Print Python Version
run: python --version
- run: python3 -m pip install --upgrade pip #==19.3.1
#- run: pip install tox-travis virtualenv>=20.0.8 --upgrade
#- run: pip install sphinx sphinx_rtd_theme recommonmark ruamel.yaml pytest
- name: Install requirements for documentation build
run: pip install -r smarthomeng/doc/requirements.txt
- name: Build Requirements for SmartHomeNG
run: python3 smarthomeng/tools/build_requirements.py
- name: Install SmartHomeNG base requirements
# base requirements are needed for building of documentation
run: pip install -r smarthomeng/requirements/base.txt
- name: List installed packages
run: pip list
- name: Build documentation
working-directory: ./smarthomeng/doc
run: bash ./build_doc_local.sh
#- name: Deploy documentation
# uses: JamesIves/[email protected]
# with:
# branch: develop_doc # The branch the action should deploy to.
# folder: ./smarthomeng/doc/user/build/html # The folder the action should deploy.
- name: Deploy documentation to seperate repo dev_doc
uses: JamesIves/[email protected]
with:
branch: gh-pages # The branch the action should deploy to.
folder: ./smarthomeng/doc/user/build/html # The folder the action should deploy.
repository-name: 'smarthomeNG/dev_doc'
token: ${{ secrets.PAT_TOKEN }}