From 38c3526b3bb75f68a8d7adde8eeca85a28170431 Mon Sep 17 00:00:00 2001 From: Radovan Bast Date: Wed, 11 Sep 2024 22:33:58 +0200 Subject: [PATCH] preparing the schedule for doc and testing --- content/documentation.md | 8 ++++++++ content/index.md | 6 ++++-- content/testing.md | 10 ++++++++++ 3 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 content/documentation.md create mode 100644 content/testing.md diff --git a/content/documentation.md b/content/documentation.md new file mode 100644 index 0000000..940f519 --- /dev/null +++ b/content/documentation.md @@ -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 diff --git a/content/index.md b/content/index.md index ff4a107..7e6b8c1 100644 --- a/content/index.md +++ b/content/index.md @@ -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 @@ -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 @@ -137,6 +137,8 @@ installation/virtual-environment :caption: Episodes :hidden: +documentation +testing refactoring publishing ``` diff --git a/content/testing.md b/content/testing.md new file mode 100644 index 0000000..7a63bd9 --- /dev/null +++ b/content/testing.md @@ -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