prefer adding_software
over contributing_sw
in docs URL + fix broken URLs using auto-redirect
#363
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
# documentation: https://help.github.com/en/articles/workflow-syntax-for-github-actions | |
name: build documentation | |
on: [push, pull_request] | |
# Declare default permissions as read only. | |
permissions: read-all | |
jobs: | |
build: | |
runs-on: ubuntu-22.04 | |
steps: | |
- name: checkout | |
uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0 | |
- name: set up Python | |
uses: actions/setup-python@13ae5bb136fac2878aff31522b9efb785519f984 # v4.3.0 | |
with: | |
python-version: '3.10' | |
- name: Codespell action | |
uses: codespell-project/actions-codespell@22ff5a2e4b591290baf82d47c9feadac31c65441 # v1.0 | |
with: | |
check_filenames: true | |
skip: '*.pdf,.git' | |
# - name: Markdown Linting Action | |
# uses: avto-dev/markdown-lint@v1.2.0 | |
# with: | |
# rules: '/lint/rules/changelog.js' | |
# config: '/lint/config/changelog.yml' | |
# args: '.' | |
- name: install mkdocs | |
run: | | |
pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin mkdocs-toc-sidebar-plugin | |
mkdocs --version | |
- name: build tutorial | |
run: make test |