site updates: fix some usage informations, make authorship clear, add… #8
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: docs | |
on: | |
push: | |
branches: | |
- main | |
permissions: | |
contents: write | |
# This job installs dependencies, builds the docs, and pushes it to | |
# the `gh-pages` branch of the same repository. | |
jobs: | |
deploy-book: | |
if: github.repository == 'SBC-Utrecht/pytom-match-pick' | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout repository | |
uses: actions/checkout@v4 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.x | |
- name: Install dependencies | |
run: | | |
pip install mkdocs mkdocs-material markdown-exec | |
# Build the book | |
- name: Build the book | |
run: | | |
mkdocs build | |
# Push the site to github-pages | |
- name: GitHub Pages action | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
publish_dir: ./site | |
github_token: ${{ secrets.GITHUB_TOKEN }} |