Skip to content

Commit 426063b

Browse files
committed
πŸ“š Add sentence+link to next topic at the end of each page
1 parent 31253e3 commit 426063b

File tree

6 files changed

+30
-0
lines changed

6 files changed

+30
-0
lines changed

β€Ždocs/documentation.mdβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,3 +208,8 @@ For example, this documentation is hosted at: [https://mbercx.github.io/softdev-
208208
The `gh-deploy` command force-pushes to the `gh-pages` branch, overwriting its history.
209209
This is usually fine since the `gh-pages` branch only contains built documentation, not source code.
210210
However, make sure you're in the right repository before deploying!
211+
212+
---
213+
214+
Your documentation is looking great! But how do you know your code actually works as expected? Let's add some automated testing to verify everything behaves correctly.
215+
**Next up: [Testing with pytest](tests.md)**

β€Ždocs/environments.mdβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -189,3 +189,8 @@ Finally, `setuptools` is a package that helps you build and distribute Python pa
189189

190190
Can't get enough of virtual environments?
191191
Read the original Python Enhancement Proposal (PEP) that introduced them into the standard library: [PEP 405](https://peps.python.org/pep-0405/).
192+
193+
---
194+
195+
With your environment set up and ready to install packages, it's time to learn how to structure your own Python code as a package.
196+
**Next up: [Packages](packages.md)**

β€Ždocs/formatting.mdβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,3 +185,8 @@ This ensures your code is always formatted and linted before it enters version c
185185

186186
Try to make some changes to one of the modules, and run `git commit`.
187187
Both the linter and formatter should run automatically.
188+
189+
---
190+
191+
You've set up local tools to check your code, but wouldn't it be nice if these checks ran automatically every time you push to GitHub? That's where Continuous Integration comes in!
192+
**Next up: [Continuous Integration (CI)](ci.md)**

β€Ždocs/packages.mdβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -168,3 +168,8 @@ To see all the remotes you have configured, use:
168168
```
169169
git remote -v
170170
```
171+
172+
---
173+
174+
You've got your package structure in place! Now let's make it easy for others (and your future self) to understand and use your code.
175+
**Next up: [Writing documentation](documentation.md)**

β€Ždocs/tests.mdβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -193,3 +193,8 @@ Change the factor in the test from 2 to 3, and see what happens.
193193
What happens with empty inputs? Very large numbers? Invalid data?
194194
- **Keep tests independent**: Each test should work on its own, not depend on other tests running first.
195195
- **Use descriptive names**: `test_add_handles_negative_numbers` is better than `test_add_2`.
196+
197+
---
198+
199+
Your tests are keeping your code reliable! Now let's make your code look professional and catch potential bugs before they happen with automated formatting and linting.
200+
**Next up: [Formatting/linting your code with Ruff](formatting.md)**

β€Ždocs/version_control.mdβ€Ž

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,3 +214,8 @@ Date: Fri Nov 7 15:17:41 2025 +1000
214214

215215
At UQ, Ben Roberts also runs a workshop on using `git` and GitHub which goes into much more detail than this tutorial.
216216
If you're curious, [have a look at the workshop material](https://github.com/benroberts999/git-workshop).
217+
218+
---
219+
220+
Now that you understand version control basics, let's move on to managing Python dependencies and isolated workspaces.
221+
**Next up: [Python environments](environments.md)**

0 commit comments

Comments
Β (0)