v0.24.10 #98
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
name: Documentation | |
on: | |
release: | |
types: | |
- created | |
jobs: | |
job: | |
name: Documentation | |
runs-on: ubuntu-latest | |
env: | |
PACKAGE_NAME: neclib | |
steps: | |
- uses: actions/checkout@v2 | |
- uses: actions/setup-python@v2 | |
with: | |
python-version: "3.10" | |
- name: Install dependencies | |
run: | | |
pip3 install poetry | |
poetry install | |
poetry run pip3 install 'setuptools==59.6' # Workaround, poetry 1.1.x removes this. | |
- name: Build docs | |
run: | | |
poetry run sphinx-apidoc -efTM -t docs/_templates/apidoc -o docs/_source ${{ env.PACKAGE_NAME }} | |
poetry run sphinx-build -a docs docs/_build | |
- name: Deploy docs | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/_build |