dev(narugo): fix docs issue #173
Workflow file for this run
This file contains 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
# This workflow will check flake style | |
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions | |
name: Docs Deploy | |
on: | |
push: | |
branches: [ main, 'doc/*', 'dev/*', 'test/*' ] | |
release: | |
types: [ published ] | |
jobs: | |
doc: | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
python-version: [ 3.7 ] | |
services: | |
plantuml: | |
image: plantuml/plantuml-server | |
ports: | |
- 18080:8080 | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Set up Python ${{ matrix.python-version }} | |
uses: actions/setup-python@v2 | |
with: | |
python-version: ${{ matrix.python-version }} | |
- name: Install dependencies | |
run: | | |
sudo apt-get update -y | |
sudo apt-get install -y make wget curl cloc graphviz | |
dot -V | |
python -m pip install -r requirements.txt | |
python -m pip install -r requirements-doc.txt | |
- name: Generate | |
env: | |
ENV_PROD: 'true' | |
PLANTUML_HOST: http://localhost:18080 | |
run: | | |
git fetch --all --tags | |
git branch -av | |
git remote -v | |
git tag | |
plantumlcli -c | |
make pdocs | |
mv ./docs/build/html ./public | |
- name: Deploy to Github Page | |
uses: JamesIves/[email protected] | |
with: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
BRANCH: gh-pages # The branch the action should deploy to. | |
FOLDER: public # The folder the action should deploy. | |
CLEAN: true # Automatically remove deleted files from the deploy branch |