Skip to content

Update readme with action #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timkpaine merged 1 commit into from
Nov 19, 2025
Merged

Update readme with action #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/docs.yml → .github/workflows/docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ on:
push:
branches: ["main"]
tags: ["v*"]
paths-ignore: ["LICENSE", "README.md"]
workflow_dispatch:
permissions:
contents: write
Expand Down
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,27 @@ Or from `conda-forge` via `conda`:
conda install yardang -c conda-forge
```

## GitHub Action

A convenient [github action](https://github.com/actions-ext/yardang) is provided to publish documentation automatically in CI.

```yaml
name: Docs
on:
push:
branches: ["main"]
tags: ["v*"]
workflow_dispatch:
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions-ext/yardang@main
with:
token: ${{ secrets.GITHUB_TOKEN }}
```

> [!NOTE]
> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).