💄 Added Turing logo (see #1). Added sections.

.github/workflows/build_docs.yaml

@@ -29,10 +29,10 @@ jobs:
       - name: Build latest documentation
         shell: bash
         run: |
-          mv docs/* .
+          cp docs/*.yml .
           make clean
           make
-          mv index.html _build
+          cp docs/index.html _build
       - name: Deploy documentation to GitHub Pages
         uses: JamesIves/github-pages-deploy-action@5dc1d5a192aeb5ab5b7d5a77b7d36aea4a7f5c92 # This is version 4.1.4
         with:

.gitignore

@@ -22,6 +22,7 @@ ch04packaging/greeter.py
 ch04packaging/greetings/dist/Greetings*.egg
 ch04packaging/greetings/doc/
 ch04packaging/greetings/doc/output/.doctrees/
+ch04packaging/greetings/doc/output/.buildinfo
 ch05construction/anotherfile.py
 ch05construction/config.yaml
 ch05construction/context.py

Makefile

@@ -1,7 +1,7 @@
 default: _site
 
 _site:
-	jupyter-book build --verbose .
+	jupyter-book build --verbose --keep-going .
 
 clean:
 	rm -rf _build

ch00python/index.md

@@ -6,4 +6,4 @@
 * List comprehensions
 * Functions in Python
 * Modules in Python
-* An introduciton to classes
+* An introduction to classes

docs/_config.yml

@@ -1,2 +1,5 @@
 title: "Research Software Engineering with Python"
-only_build_toc_files: true
+logo: docs/ATI_logo_black_W1024px.png
+only_build_toc_files: true
+execute:
+  execute_notebooks: cache

docs/_toc.yml

@@ -1,108 +1,114 @@
 format: jb-book
 root: index.md
-chapters:
-- file: ch00python/index.md
-  sections:
-  - file: ch00python/00pythons.ipynb
-  - file: ch00python/010exemplar.ipynb
-  - file: ch00python/015variables.ipynb
-  - file: ch00python/016using_functions.ipynb
-  - file: ch00python/023types.ipynb
-  - file: ch00python/025containers.ipynb
-  - file: ch00python/028dictionaries.ipynb
-  - file: ch00python/029structures.ipynb
-  - file: ch00python/030MazeSolution.ipynb
-  - file: ch00python/032conditionality.ipynb
-  - file: ch00python/035looping.ipynb
-  - file: ch00python/036MazeSolution2.ipynb
-  - file: ch00python/037comprehensions.ipynb
-  - file: ch00python/038SolutionComprehension.ipynb
-  - file: ch00python/040functions.ipynb
-  - file: ch00python/050import.ipynb
-  - file: ch00python/101Classes.ipynb
-- file: ch01data/index.md
-  sections:
-  - file: ch01data/060files.ipynb
-  - file: ch01data/061internet.ipynb
-  - file: ch01data/062csv.ipynb
-  - file: ch01data/064JsonYamlXML.ipynb
-  - file: ch01data/065MazeSaved.ipynb
-  - file: ch01data/066QuakeExercise.ipynb
-  - file: ch01data/068QuakesSolution.ipynb
-  - file: ch01data/072plotting.ipynb
-  - file: ch01data/082NumPy.ipynb
-  - file: ch01data/084Boids.ipynb
-  - file: ch01data/110Capstone.ipynb
-- file: ch02git/index.md
-  sections:
-  - file: ch02git/01Intro.ipynb
-  - file: ch02git/02Solo.ipynb
-  - file: ch02git/03Mistakes.ipynb
-  - file: ch02git/04Publishing.ipynb
-  - file: ch02git/05Collaboration.ipynb
-  - file: ch02git/06ForkAndPull.ipynb
-  - file: ch02git/09GitTheory.ipynb
-  - file: ch02git/10Branches.ipynb
-  - file: ch02git/11Miscellany.ipynb
-  - file: ch02git/12Remotes.ipynb
-  - file: ch02git/13Rebase.ipynb
-  - file: ch02git/14Bisect.ipynb
-- file: ch03tests/index.md
-  sections:
-  - file: ch03tests/01testingbasics.ipynb
-  - file: ch03tests/02SaskatchewanFields.ipynb
-  - file: ch03tests/03pytest.ipynb
-  - file: ch03tests/04EnergyExample.ipynb
-  - file: ch03tests/05Mocks.ipynb
-  - file: ch03tests/06Debugger.ipynb
-  - file: ch03tests/07CI.ipynb
-  - file: ch03tests/08DiffusionExample.ipynb
-- file: ch04packaging/index.md
-  sections:
-  - file: ch04packaging/01Installation.ipynb
-  - file: ch04packaging/02Libraries.ipynb
-  - file: ch04packaging/03Argparse.ipynb
-  - file: ch04packaging/04WritingLibraries.ipynb
-  - file: ch04packaging/05Packaging.ipynb
-  - file: ch04packaging/06Documentation.ipynb
-  - file: ch04packaging/07Process.ipynb
-  - file: ch04packaging/08Licensing.ipynb
-  - file: ch04packaging/09Issues.ipynb
-- file: ch05construction/index.md
-  sections:
-  - file: ch05construction/01introduction.ipynb
-  - file: ch05construction/02conventions.ipynb
-  - file: ch05construction/03comments.ipynb
-  - file: ch05construction/05refactoring.ipynb
-  - file: ch05construction/06objects.ipynb
-  - file: ch05construction/08objects.ipynb
-  - file: ch05construction/09patterns.ipynb
-  - file: ch05construction/10boids.ipynb
-- file: ch07dry/index.md
-  sections:
-  - file: ch07dry/01intro.ipynb
-  - file: ch07dry/020Functional.ipynb
-  - file: ch07dry/025Iterators.ipynb
-  - file: ch07dry/040Exceptions.ipynb
-  - file: ch07dry/049Operators.ipynb
-  - file: ch07dry/050OperatorsExample.ipynb
-  - file: ch07dry/060Metaprogramming.ipynb
-- file: ch08performance/index.md
-  sections:
-  - file: ch08performance/010intro.ipynb
-  - file: ch08performance/015mandels.ipynb
-  - file: ch08performance/020numpy.ipynb
-  - file: ch08performance/040cython.ipynb
-  - file: ch08performance/050scaling.ipynb
-- file: ch09fileformats/index.md
-  sections:
-  - file: ch09fileformats/07SerialisationAndNormalisation.ipynb
-  - file: ch09fileformats/08Deserialisation.ipynb
-  - file: ch09fileformats/09DSLs.ipynb
-  - file: ch09fileformats/10MarkupLanguages.ipynb
-  - file: ch09fileformats/11ControlledVocabularies.ipynb
-  - file: ch09fileformats/12SemanticModels.ipynb
-- file: ch98rubrics/index.md
-  sections:
-  - file: ch98rubrics/PackagingTreasure.ipynb
-  - file: ch98rubrics/RefactoringTrees.ipynb
+options:
+  numbered: True
+parts:
+- caption: Course contents
+  chapters:
+  - file: ch00python/index.md
+    sections:
+    - file: ch00python/00pythons.ipynb
+    - file: ch00python/010exemplar.ipynb
+    - file: ch00python/015variables.ipynb
+    - file: ch00python/016using_functions.ipynb
+    - file: ch00python/023types.ipynb
+    - file: ch00python/025containers.ipynb
+    - file: ch00python/028dictionaries.ipynb
+    - file: ch00python/029structures.ipynb
+    - file: ch00python/030MazeSolution.ipynb
+    - file: ch00python/032conditionality.ipynb
+    - file: ch00python/035looping.ipynb
+    - file: ch00python/036MazeSolution2.ipynb
+    - file: ch00python/037comprehensions.ipynb
+    - file: ch00python/038SolutionComprehension.ipynb
+    - file: ch00python/040functions.ipynb
+    - file: ch00python/050import.ipynb
+    - file: ch00python/101Classes.ipynb
+  - file: ch01data/index.md
+    sections:
+    - file: ch01data/060files.ipynb
+    - file: ch01data/061internet.ipynb
+    - file: ch01data/062csv.ipynb
+    - file: ch01data/064JsonYamlXML.ipynb
+    - file: ch01data/065MazeSaved.ipynb
+    - file: ch01data/066QuakeExercise.ipynb
+    - file: ch01data/068QuakesSolution.ipynb
+    - file: ch01data/072plotting.ipynb
+    - file: ch01data/082NumPy.ipynb
+    - file: ch01data/084Boids.ipynb
+    - file: ch01data/110Capstone.ipynb
+  - file: ch02git/index.md
+    sections:
+    - file: ch02git/01Intro.ipynb
+    - file: ch02git/02Solo.ipynb
+    - file: ch02git/03Mistakes.ipynb
+    - file: ch02git/04Publishing.ipynb
+    - file: ch02git/05Collaboration.ipynb
+    - file: ch02git/06ForkAndPull.ipynb
+    - file: ch02git/09GitTheory.ipynb
+    - file: ch02git/10Branches.ipynb
+    - file: ch02git/11Miscellany.ipynb
+    - file: ch02git/12Remotes.ipynb
+    - file: ch02git/13Rebase.ipynb
+    - file: ch02git/14Bisect.ipynb
+  - file: ch03tests/index.md
+    sections:
+    - file: ch03tests/01testingbasics.ipynb
+    - file: ch03tests/02SaskatchewanFields.ipynb
+    - file: ch03tests/03pytest.ipynb
+    - file: ch03tests/04EnergyExample.ipynb
+    - file: ch03tests/05Mocks.ipynb
+    - file: ch03tests/06Debugger.ipynb
+    - file: ch03tests/07CI.ipynb
+    - file: ch03tests/08DiffusionExample.ipynb
+  - file: ch04packaging/index.md
+    sections:
+    - file: ch04packaging/01Installation.ipynb
+    - file: ch04packaging/02Libraries.ipynb
+    - file: ch04packaging/03Argparse.ipynb
+    - file: ch04packaging/04WritingLibraries.ipynb
+    - file: ch04packaging/05Packaging.ipynb
+    - file: ch04packaging/06Documentation.ipynb
+    - file: ch04packaging/07Process.ipynb
+    - file: ch04packaging/08Licensing.ipynb
+    - file: ch04packaging/09Issues.ipynb
+  - file: ch05construction/index.md
+    sections:
+    - file: ch05construction/01introduction.ipynb
+    - file: ch05construction/02conventions.ipynb
+    - file: ch05construction/03comments.ipynb
+    - file: ch05construction/05refactoring.ipynb
+    - file: ch05construction/06objects.ipynb
+    - file: ch05construction/08objects.ipynb
+    - file: ch05construction/09patterns.ipynb
+    - file: ch05construction/10boids.ipynb
+  - file: ch07dry/index.md
+    sections:
+    - file: ch07dry/01intro.ipynb
+    - file: ch07dry/020Functional.ipynb
+    - file: ch07dry/025Iterators.ipynb
+    - file: ch07dry/040Exceptions.ipynb
+    - file: ch07dry/049Operators.ipynb
+    - file: ch07dry/050OperatorsExample.ipynb
+    - file: ch07dry/060Metaprogramming.ipynb
+  - file: ch08performance/index.md
+    sections:
+    - file: ch08performance/010intro.ipynb
+    - file: ch08performance/015mandels.ipynb
+    - file: ch08performance/020numpy.ipynb
+    - file: ch08performance/040cython.ipynb
+    - file: ch08performance/050scaling.ipynb
+  - file: ch09fileformats/index.md
+    sections:
+    - file: ch09fileformats/07SerialisationAndNormalisation.ipynb
+    - file: ch09fileformats/08Deserialisation.ipynb
+    - file: ch09fileformats/09DSLs.ipynb
+    - file: ch09fileformats/10MarkupLanguages.ipynb
+    - file: ch09fileformats/11ControlledVocabularies.ipynb
+    - file: ch09fileformats/12SemanticModels.ipynb
+- caption: Assessment
+  chapters:
+  - file: ch98rubrics/index.md
+    sections:
+    - file: ch98rubrics/PackagingTreasure.ipynb
+    - file: ch98rubrics/RefactoringTrees.ipynb