Skip to content

Fix the changelog heading level #266

Fix the changelog heading level

Fix the changelog heading level #266

Workflow file for this run

#
# Build and deploy documentation
#
name: Docs
on:
push:
branches: [main]
paths:
- 'HinetPy/*.py'
- 'docs/**'
- 'README.rst'
pull_request:
paths:
- 'HinetPy/*.py'
- 'docs/**'
- 'README.rst'
workflow_dispatch:
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
jobs:
deploy-docs:
name: Docs
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
# fecth all history so that setuptools-scm works
fetch-depth: 0
- name: Set up Python 3.x
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install -r requirements.txt
python -m pip install build sphinx sphinx-intl sphinx_rtd_theme
python -m build --sdist
python -m pip install dist/*
- name: Build documentation
run: make doc
- name: Deploy to GitHub Pages
uses: peaceiris/[email protected]
# Only deploy on main branch
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./docs/_build/html