Skip to content

Commit

Permalink
preparing the schedule for doc and testing
Browse files Browse the repository at this point in the history
  • Loading branch information
bast committed Sep 11, 2024
1 parent d6369e1 commit 38c3526
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 2 deletions.
8 changes: 8 additions & 0 deletions content/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
(documentation)=

# Code documentation

- 15 min: What makes good documentation? Also https://diataxis.fr/
- 15 min: Writing good README files
- 30 min: Exercise: Set up a Sphinx documentation and add API documentation
- 15 min: Building documentation with GitHub Actions
6 changes: 4 additions & 2 deletions content/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ The schedule will very soon contain links to lesson material and exercises.
- Branching and merging
- Recovering from typical mistakes

- 16:45-18:00 (1.25h) - **Documentation**
- 16:45-18:00 (1.25h) - {ref}`documentation`
- In-code documentation including docstrings
- Writing good README files
- Markdown
Expand Down Expand Up @@ -85,7 +85,7 @@ The schedule will very soon contain links to lesson material and exercises.

### Day 3 (Sep 18)

- 09:00-10:30 (1.5h) - **Automated testing**
- 09:00-10:30 (1.5h) - {ref}`testing`
- Unit tests
- End-to-end tests
- pytest
Expand Down Expand Up @@ -137,6 +137,8 @@ installation/virtual-environment
:caption: Episodes
:hidden:
documentation
testing
refactoring
publishing
```
Expand Down
10 changes: 10 additions & 0 deletions content/testing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
(testing)=

# Automated testing

- 15 min: Motivation
- 15 min: End-to-end tests
- 15 min: Pytest
- 15 min: Moving to GitHub Actions
- 20 min: Exercise
- 10 min: Where to go from here

0 comments on commit 38c3526

Please sign in to comment.