You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/history.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,8 +3,9 @@
3
3
`(#{number})` means an issue of this project. You may check details of the issue by visiting https://github.com/zillionare/python-project-wizard/issues/_{number}_
before launch the script, you will need to apply github personal token and set environment variable GH_TOKEN beforehand. And you need install the tool [**gh**](https://cli.github.com/) too.
175
175
@@ -225,7 +225,7 @@ In your browser, visit [install codecov app], you'll be landed at this page:
225
225
Click on the green `install` button at top right, choose `all repositories` then click
226
226
on `install` button, following directions until all sets.
227
227
228
-
###Step 9: Check the CI result
228
+
## Step 9: Check the CI result
229
229
230
230
After pushing your code to github, go to github web page, navigate to your repo, then
231
231
click on actions link, you should find screen like this:
@@ -237,28 +237,25 @@ new artifact is published under the name {{ cookiecutter.project_slug }}
Documentation will be published and available at <https://{your_github_account}.github.io/{your_repo}> once:
242
241
243
242
1. the branch is either main or master
244
243
2. the commit is tagged, and the tag name is started with 'v' (lower case)
245
244
3. build/testing executed by github CI passed
246
245
247
-
If you'd like to see what it looks like now, you could run the followng command:
246
+
If you'd like to see what it looks like now, you could run the followng command:
248
247
249
248
```
250
249
mkdocs gh-deploy
251
250
```
252
251
253
-
then check your documentation at <https://{your_github_account}.github.io/{your_repo}>
254
-
255
-
or you can serve it locally by:
252
+
then check your documentation at <https://{your_github_account}.github.io/{your_repo}> or you can serve it locally by:
256
253
257
254
```
258
255
mkdocs serve -a 0.0.0.0:8000
259
256
```
260
257
261
-
then open your browser, visit your dev machine on port 8000.
258
+
then open your browser, visit your dev machine on port 8000.
262
259
263
260
???+ Info
264
261
Though we used mkdocs here, however, in order to support multiple versions of documentation, we actually use mike in github actions.
@@ -272,7 +269,7 @@ new artifact is published under the name {{ cookiecutter.project_slug }}
272
269
273
270
## Step 11. Make an official release
274
271
275
-
After done with your phased development, switch to either of (main, master) branch, following instructions at [release checklist](/python-project-wizard/pypi_release_checklist), trigger first official release and check result at [PYPI].
272
+
After done with your phased development, switch to either of (main, master) branch, following instructions at [release checklist](/pypi_release_checklist), trigger first official release and check result at [PYPI].
0 commit comments