Skip to content

Commit

Permalink
Update the documentation #36
Browse files Browse the repository at this point in the history
  • Loading branch information
Ludee committed Aug 14, 2023
1 parent 994244a commit 3e19368
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/development/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ It is configured to be pushed to the branch `gh-page` and then deployed online.
A commit on the `production` branch triggers the workflow.

!!! warning "Using mike with GitHub Actions"
This feature is not compatible with the versioning of the documentation with `mike`. <br>
The action overrides all manually deployed versions! <br>
This feature is not compatible with the versioning of the documentation with `mike`! <br>
The action overrides all manually deployed versions. <br>
🐙 To disable an existing `GitHub Action`, follow [these instructions](https://docs.github.com/de/enterprise-cloud@latest/actions/using-workflows/disabling-and-enabling-a-workflow).

### Mike
Expand All @@ -48,22 +48,23 @@ The package [mike](https://github.com/jimporter/mike) is used to deploy [multipl
💻 `mike set-default --push latest` Set the default version to latest

!!! note "Mike Versions"
It is recommended to use only the Minor Versions (e.g. 0.1) and exclude the patch number.
It is recommended to use only the **Minor Versions** (e.g. 0.1) and exclude the **Patch Version** (e.g. 0.1.1)!

Other useful commands are: <br>
💻 `mike serve` test mike on `http://localhost:8000` <br>
💻 `mike serve` test mike on [`http://localhost:8000`](http://localhost:8000) <br>
💻 `mike list` list all versions <br>
💻 `mike retitle 1.0.0 1.0.1 --push` list all versions <br>
💻 `mike retitle 1.0.0 1.0.1 --push` rename a version <br>
💻 `mike delete 0.1 --push` deletes a specific versions <br>
💻 `mike delete --all --push` deletes all versions

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

When building mike locally, the branch `gh-pages` is modified locally. <br>
💻 `error: gh-pages is unrelated to origin/gh-pages` <br>
💠 `git branch -D gh-pages` delete the local documentation branch

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

## mkdocstrings
[mkdocstrings](https://mkdocstrings.github.io/) generates automatic
documentation (autodocs) from [Google style docstrings](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html). <br>
Expand Down

0 comments on commit 3e19368

Please sign in to comment.