Skip to content

Commit

Permalink
Include deploy of develop branch #4
Browse files Browse the repository at this point in the history
  • Loading branch information
Ludee committed Aug 17, 2023
1 parent 27095e4 commit 216009b
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/development/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ The package [mike](https://github.com/jimporter/mike) is used to deploy [multipl
💻 `pip install mike` install mike <br>
💻 `mike deploy --push --update-aliases 0.1 latest` deploys the latest version <br>
💻 `mike set-default --push latest` Set the default version to latest
💻 `mike deploy develop --push` deploys the develop branch

!!! note "Mike Versions"
It is recommended to use only the **Minor Versions** (e.g. 0.1) and exclude the **Patch Version** (e.g. 0.1.1)!
Expand All @@ -59,7 +60,7 @@ Other useful commands are: <br>

When adding older versions, load the `Git Tags` used for the releases: <br>
💠 `git checkout v0.1.1` <br>
💻 `mike deploy --push --update-aliases 0.1 latest` deploys the old version
💻 `mike deploy 0.1 --push` deploys the old version 0.1

When building mike locally, the branch `gh-pages` is modified locally. <br>
💻 `error: gh-pages is unrelated to origin/gh-pages` <br>
Expand Down

0 comments on commit 216009b

Please sign in to comment.