Skip to content

Commit 5bfe2af

Browse files
committed
add screenshots for gh-pages settings
1 parent 354abec commit 5bfe2af

2 files changed

Lines changed: 3 additions & 4 deletions

File tree

episodes/42-software-reuse.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -320,10 +320,7 @@ This will start to build a local static documentation site and serve it at a loc
320320
By default, it will be available at `http://127.0.0.1:8000/`, which will also show in the terminal output.
321321
You can open this URL in your web browser to view the documentation site.
322322

323-
The documentation site now consists some default content about MKDocs. It is rendered from the `docs/index.md` file. Let's edit this file to add some relevant content about our project.
324-
325-
Update `docs/index.md` with some relevant content.
326-
For simplicity, we can borrow the content from our `README.md` file.
323+
The documentation site now consists some default content about MKDocs. It is rendered from the `docs/index.md` file. Let's edit this file to add some relevant content about our project. For simplicity, we can borrow the content from our `README.md` file.
327324

328325
::::::::::::::::::::::::::::::::: challenge
329326

@@ -406,6 +403,8 @@ mkdocs gh-deploy
406403

407404
This command assumes you have access to the GitHub repository of the current project. It will automatically create a new branch called `gh-pages` in your repository, which will contain the static files of your documentation site, and push this branch to GitHub.
408405

406+
![](./fig/github-gh-page-settings.png){alt='GitHub Pages settings details' .image-with-shadow width="800px"}
407+
409408
Now go check your repository's GitHub Pages "Settings -> Pages", you should see the link to your documentation site, which should be like: `https://<github_user_id>.github.io/python-intermediate-inflammation/`. You can add this link to your GitHub repository landing page description.
410409

411410
### Thinking about the audience for your documentation
186 KB
Loading

0 commit comments

Comments
 (0)