Skip to content

Commit aedc357

Browse files
authored
docs: Improve gh-pages initialization (#203)
Fixes #188.
2 parents b638e66 + 04f56af commit aedc357

File tree

1 file changed

+7
-5
lines changed
  • docs/user-guide/start-a-new-project

1 file changed

+7
-5
lines changed

docs/user-guide/start-a-new-project/index.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,8 @@ initial setup is needed for it to work correctly:
128128
129129
```sh
130130
pip install -e .[dev-mkdocs] # Not necessary if you already installed .[dev]
131-
mike deploy --update-aliases v0.1-dev latest-dev latest # Creates the branch gh-pages locally
131+
# Creates the branch gh-pages locally
132+
mike deploy --update-aliases v0.1-dev v0-dev latest-dev latest
132133
mike set-default latest # Makes the latest alias the default version
133134
git push upstream gh-pages # Pushes the new branch upstream to publish the website
134135
```
@@ -147,10 +148,11 @@ The above commands create a new documentation version using
147148
[Mike](https://pypi.org/project/mike/), which is used to keep multiple versions
148149
of the website.
149150
150-
The new documentation version is called `v0.1-dev`, which is used as the name for
151-
the currently in-development branch. The `v0.1-dev` branch has an alias called
152-
`latest-dev` that points to the latest in-development version, and `latest`
153-
alias, which is set as the *default*.
151+
The new documentation version is called `v0.1-dev`, which is used as the name
152+
for the currently in-development branch. The `v0.1-dev` branch has an alias
153+
called `v0-dev` that points to the latest v0.x branch development version, an
154+
alias `latest-dev` that points to the latest in-development version, and
155+
a `latest` alias, which is set as the *default*.
154156
155157
If the website is visited without specifying an explicit version, the `latest`
156158
version will be displayed. It is recommended to point `latest` to the latest

0 commit comments

Comments
 (0)