From 4227030f282714274c3c974a4343663d8086c665 Mon Sep 17 00:00:00 2001 From: Michele Mesiti Date: Mon, 16 Mar 2026 14:22:37 +0100 Subject: [PATCH 1/3] Reorder episodes according to priority Closes #321 --- content/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/index.md b/content/index.md index 36f79e7d..d49b310d 100644 --- a/content/index.md +++ b/content/index.md @@ -50,12 +50,12 @@ recorded a [short shell crash course](https://youtu.be/xbTTDLA3txI). :maxdepth: 1 :caption: The lesson -wishlist.md -tools.md in-code-documentation.md writing-readme-files.md sphinx.md gh_workflow.md +wishlist.md +tools.md summary.md ``` From 069db3b521b947127fc1a1f9a468e658febb977d Mon Sep 17 00:00:00 2001 From: Michele Mesiti Date: Mon, 16 Mar 2026 14:32:05 +0100 Subject: [PATCH 2/3] Reorder/Update timings in index --- content/index.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/content/index.md b/content/index.md index d49b310d..a8a4c693 100644 --- a/content/index.md +++ b/content/index.md @@ -36,13 +36,14 @@ recorded a [short shell crash course](https://youtu.be/xbTTDLA3txI). ```{csv-table} :widths: auto :delim: ; - -10 min ; {doc}`wishlist` +5 min ; Intro +5 min ; {doc}`in-code-documentation` +10 min ; {doc}`writing-readme-files` +35 min ; {doc}`sphinx` (with exercise) +10 min ; Break +30 min ; {doc}`gh_workflow` (with exercise) 10 min ; {doc}`tools` -20 min ; {doc}`in-code-documentation` -30 min ; {doc}`writing-readme-files` -30 min ; {doc}`sphinx` -20 min ; {doc}`gh_workflow` +10 min ; {doc}`wishlist` 5 min ; {doc}`summary` ``` From aa9b8865dfbf9a49f2ee0f31f5c6e7076e170023 Mon Sep 17 00:00:00 2001 From: Michele Mesiti Date: Tue, 17 Mar 2026 17:10:27 +0100 Subject: [PATCH 3/3] tools: make independent from episode order "we will talk about this in " -> "we talk about this in " --- content/tools.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/tools.md b/content/tools.md index cff8afd7..2a09d980 100644 --- a/content/tools.md +++ b/content/tools.md @@ -21,7 +21,7 @@ - Disadvantage - Probably not enough for users of the code -We will have a closer look at this in the {ref}`in-code-documentation` episode. +For a closer look at this see the {ref}`in-code-documentation` episode. --- @@ -35,7 +35,7 @@ We will have a closer look at this in the {ref}`in-code-documentation` episode. [Markdown](https://commonmark.org/help/) - A great guide to README files: [MakeaREADME](https://www.makeareadme.com/) -We will have a closer look at this in the {ref}`writing-readme-files` episode. +For a closer look at this see the {ref}`writing-readme-files` episode. --- @@ -71,7 +71,7 @@ tables, links, ... tables, links, ... - There are (unfortunately) [many flavors of Markdown](https://github.com/jgm/CommonMark/wiki/Markdown-Flavors). - Motivation to stick to a standard text-based format: **They make it easier to move the documentation to other tools which also expect a standard format, as the project/organization grows**. -- We will use [MyST](https://myst-parser.readthedocs.io/en/latest/) +- We use [MyST](https://myst-parser.readthedocs.io/en/latest/) flavored Markdown in the {ref}`sphinx` episode and the {ref}`gh-pages` example. - Nice resource to learn Markdown: [Learn Markdown in 60 seconds](https://commonmark.org/help/) @@ -83,7 +83,7 @@ tables, links, ... tables, links, ... There are many tools that can turn RST or Markdown into beautiful HTML pages: -- [Sphinx](https://www.sphinx-doc.org) **← we will exercise this, this is how this lesson material is built** +- [Sphinx](https://www.sphinx-doc.org) **← this is how this lesson material is built** - Generate HTML/PDF/LaTeX from RST and Markdown. - Basically all Python projects use Sphinx but **Sphinx is not limited to Python**. - [Read the docs](https://readthedocs.org)