Skip to content

feat: init docs for cli #85

feat: init docs for cli

feat: init docs for cli #85

Workflow file for this run

name: CI
on:
pull_request:
types: [opened, synchronize]
push:
branches: ['master', 'main']
env:
PYTHONPATH: './src:./test'
jobs:
# build:
# strategy:
# fail-fast: false
# matrix:
# os: ['ubuntu-latest']
# python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
# runs-on: ${{ matrix.os }}
# steps:
# - uses: actions/checkout@v4
# - uses: actions/setup-python@v5
# with:
# python-version: ${{ matrix.python-version }}
# cache: 'pip'
# - name: setup tox
# run: pip install tox
# - name: test
# run: |
# TOXENV="py$(echo ${{ matrix.python-version }} | sed 's/\.//')"
# tox -e "${TOXENV}"
docs:
# needs: build
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Install dependencies
run: pip install -r requirements-docs.txt
- name: Sphinx build
run: sphinx-build docs docs/_build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e # v4.0.0
# if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/
force_orphan: true
enable_jekyll: false
keep_files: false