Update README.md (#271) #186
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
name: Test Docs | |
on: | |
push: | |
branches: [main] | |
pull_request: | |
env: | |
POETRY_VERSION: "1.3.1" | |
jobs: | |
docs: | |
runs-on: ubuntu-latest | |
steps: | |
- name: check | |
run: | | |
echo ${{ github.event.pull_request.merged }} | |
echo ${{ github.event.pull_request.labels }} | |
echo ${{ github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'doc-publish') }} | |
- uses: actions/checkout@v3 | |
- name: Install poetry | |
run: pipx install poetry==$POETRY_VERSION | |
- name: Set up Python 3.11 | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.11" | |
cache: "poetry" | |
- name: Install dependencies | |
shell: bash | |
run: poetry install --with=doc | |
- name: sphinx-apidoc | |
shell: bash | |
run: | | |
poetry run poe apidoc | |
- name: Sphinx build | |
shell: bash | |
run: | | |
poetry run sphinx-build docs/source _build |