Generate Docs #30
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: Generate Docs | |
| on: | |
| workflow_run: | |
| workflows: [Upload Python Package] | |
| types: | |
| - completed | |
| # Allows you to run this workflow manually from the Actions tab | |
| workflow_dispatch: | |
| jobs: | |
| deploy: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v5 | |
| # This latest python way can't find the librdkafka.h files | |
| # - name: Set up Python | |
| # uses: actions/setup-python@v4 | |
| # with: | |
| # python-version: '3.x' | |
| - name: Install requirements | |
| run: pip install .[all] | |
| - name: Generate keyword documentation | |
| run: python3 -m robot.libdoc -f html src/ConfluentKafkaLibrary docs/index.html | |
| - uses: stefanzweifel/git-auto-commit-action@v6 | |
| with: | |
| file_pattern: docs/index.html | |
| commit_message: Add keyword documentation | |
| push_options: '--force' | |
| - name: Deploy 🚀 | |
| uses: JamesIves/github-pages-deploy-action@v4.5.0 | |
| with: | |
| branch: gh-pages # The branch the action should deploy to. | |
| folder: docs # The folder the action should deploy. |