Repository navigation
update doc #207
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: "Build doc from develop (plugins)" | |
| on: | |
| workflow_dispatch: | |
| push: | |
| branches: | |
| - 'develop' | |
| jobs: | |
| build: | |
| # Only run on the upstream repository — forks have no dev_doc companion repo | |
| # and lack the PAT_TOKEN secret required for the deploy step. | |
| if: github.repository == 'smarthomeNG/plugins' | |
| runs-on: ubuntu-22.04 #latest | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| python-version: ['3.11'] | |
| 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 | |
| - run: sudo locale-gen de_DE.UTF-8 | |
| - run: locale -a | |
| - uses: actions/checkout@v4 | |
| - name: Checkout SmartHomeNG DEVELOP Branch | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: smarthomeNG/smarthome | |
| ref: develop | |
| path: smarthomeng | |
| - name: Checkout SmartHomeNG/plugins DEVELOP Branch | |
| uses: actions/checkout@v4 | |
| with: | |
| repository: smarthomeNG/plugins | |
| ref: develop | |
| path: smarthomeng/plugins | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: ${{ matrix.python-version }} | |
| architecture: x64 | |
| - name: Print Python Version | |
| run: python --version | |
| - run: python3 -m pip install --upgrade pip | |
| - 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 to seperate repo dev_doc | |
| uses: JamesIves/github-pages-deploy-action@v4.3.3 | |
| with: | |
| branch: gh-pages | |
| folder: ./smarthomeng/doc/user/build/html | |
| repository-name: 'smarthomeNG/dev_doc' | |
| token: ${{ secrets.PAT_TOKEN }} |