Skip to content

Commit 4f618d4

Browse files
committed
update docs for ghdocs deploy
1 parent 3add857 commit 4f618d4

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

docs/tutorial.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,31 @@ new artifact is published under the name `project_slug`.
144144

145145
## Step 7. Check documentation
146146

147-
Documentation will be published and available at *https://{your_github_account}.github.io/{your_repo}* once:
147+
Documentation will be published and available at *https://{your_github_account}.github.io/{your_repo}* You will
148+
need to make sure GitHub is configured properly:
149+
150+
1. Your repro must be public
151+
2. On the main top horizontal menu go to "Settings"
152+
2. On the left-hand menu go to "Pages"
153+
3. Under "Build and deployment" make sure Source dropdown is set to "Deploy from a branch"
154+
4. Under branch choose "gh-pages" and "/(root)" - click the Save button
155+
156+
You may need to wait up to 10 minutes for your documentation to appear. If you are still having issues you
157+
can manually deploy it by the following steps:
158+
159+
1. Make sure a local virtual environment is configured.
160+
2. Pip install the following pakcages:
161+
162+
```
163+
pip install mkdocs-material mkdocs-autorefs mkdocs-material-extensions mkdocstrings mkdocstrings-python-legacy mkdocs-include-markdown-plugin
164+
```
165+
3. run the following command:
166+
167+
```
168+
mkdocs gh-deploy
169+
```
170+
171+
Documentation updates will be published once:
148172

149173
1. the commit is tagged, and the tag name is started with 'v' (lower case)
150174
2. build/testing executed by GitHub CI passed

0 commit comments

Comments
 (0)