Skip to content

Reorder episodes according to priority #325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mmesiti wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Reorder episodes according to priority #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4227030
Reorder episodes according to priority
mmesiti Mar 16, 2026
069db3b
Reorder/Update timings in index
mmesiti Mar 16, 2026
aa9b886
tools: make independent from episode order
mmesiti Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions content/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,26 +36,27 @@ 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`
```

```{toctree}
: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
```

Expand Down
8 changes: 4 additions & 4 deletions content/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand All @@ -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.

---

Expand Down Expand Up @@ -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/)
Expand All @@ -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)
Expand Down
Loading