Skip to content

Commit

Permalink
docs: add mkdocs example
Browse files Browse the repository at this point in the history
  • Loading branch information
hairmare committed Mar 25, 2024
1 parent a5d2829 commit 3aed3a4
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,26 @@ jobs:

Configure your `pyproject.toml` for releasing and your `mkdocs.yml` to generate proper documentation and you are good to go.

### Mkdocs

For repos that contain documentation built with mkdocs that do not use the poetry action.

Create a `.github/workflows/release.yaml` file with the following content:

```
name: Release
on:
push:
main
pull_request:
jobs:
release-mkdocs:
uses: radiorabe/actions/.github/workflows/release-mkdocs.yaml@v0.0.0
```

Add a `mkdocs.yaml` config and `docs/` directory and you are good to go.

### Semantic Release

Expand Down

0 comments on commit 3aed3a4

Please sign in to comment.