Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions doc/changes/unreleased.md
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
# Unreleased

## 📚 Documentation
* Updated getting_started.rst for allowing tag-based releases
11 changes: 11 additions & 0 deletions doc/user_guide/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -184,11 +184,22 @@ forward, and you just can use the example *noxfile.py* below.
Within the `gh-pages.yml`, we use the GitHub `upload-pages-artifact` and `deploy-pages`
actions. In order to properly deploy your pages, you'll need to reconfigure the GitHub
Pages settings for the repo:

1. Go to the affected repo's GitHub page
2. Select 'Settings'
3. Scroll down & select 'Pages'
4. Within the 'Build and deployment' section, change 'Source' to 'GitHub Actions'.

We also need to configure settings for github-pages environment:

1. Go to the affected repo's GitHub page
2. Select 'Settings'
3. Scroll down & select 'Environment'
4. Click on 'github-pages'
5. In the 'Deployment branches and tags', click 'Add deployment branch or tag rule'
6. Select 'Ref type' to be 'Tag' and set the 'Name pattern' to `[0-9]*.[0-9]*.[0-9]*` (or whatever matches that repo's tags)


8. Go 🥜
+++++++++++++
You are ready to use the toolbox. With *nox -l* you can list all available tasks.
Expand Down