Skip to content

Commit

Permalink
workflows: Added workflows to build documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
msinn committed May 14, 2022
1 parent 04f9a7b commit d3a24e4
Show file tree
Hide file tree
Showing 2 changed files with 138 additions and 0 deletions.
68 changes: 68 additions & 0 deletions .github/workflows/builddevdoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
name: "Build doc from develop"
#on: [workflow_dispatch, push]
on:
workflow_dispatch:
push:
branches:
- 'develop'
env:
DEP_PATH: smarthomeng/requirements/all.txt
jobs:
build:
runs-on: ubuntu-20.04 #latest
strategy:
fail-fast: false
matrix:
python-version: [ '3.8' ]
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: 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 }}
70 changes: 70 additions & 0 deletions .github/workflows/buildreleasedoc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
name: "Build doc from master"
#on: [workflow_dispatch, push]
on:
workflow_dispatch:
push:
branches:
- 'master'
env:
DEP_PATH: smarthomeng/requirements/all.txt
jobs:
build:
runs-on: ubuntu-20.04 #latest
strategy:
fail-fast: false
matrix:
python-version: [ '3.8' ]
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: master
path: smarthomeng
- name: Checkout SmartHomeNG/plugins DEVELOP Branch
uses: actions/checkout@v2
with:
repository: smarthomeNG/plugins
ref: master
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

- name: Install requirements for documentation build
run: pip install -r smarthomeng/doc/requirements.txt
- run: pip install attrs # install seperatly until requirements in master branch are updated

- 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: release_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: release_doc # The branch the action should deploy to.
folder: ./smarthomeng/doc/user/build/html # The folder the action should deploy.
repository-name: 'smarthomeNG/smarthome'
token: ${{ secrets.PAT_TOKEN }}

0 comments on commit d3a24e4

Please sign in to comment.