Upgraded tools and deployment process.

oraqlle · oraqlle · commit 30c81760886e · 2024-12-02T12:23:19.000+11:00
Upgraded mdbook and mdbook-admonish versions used locally and in
build/deployment pipeline.

Updated various utility GitHub Action in deployment script.

Commented out pages in SUMMARY to not make the book appear as
full/complete in its final form.

Updated mdbook-admonish CSS.

Updated setup instructions in README.
diff --git a/.github/workflows/mdbook.yml b/.github/workflows/mdbook.yml
@@ -29,25 +29,25 @@ jobs:
   build:
     runs-on: ubuntu-latest
     env:
-      MDBOOK_VERSION: 0.4.35
+      MDBOOK_VERSION: 0.4.40
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Install mdBook
         run: |
           curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
           rustup update
           cargo install --version ${MDBOOK_VERSION} mdbook
       - name: Install and Setup Admonish
         run: |
-          cargo install mdbook-admonish --vers "1.13.1" --locked
+          cargo install mdbook-admonish --vers "1.18.0" --locked
           mdbook-admonish install .
       - name: Setup Pages
         id: pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v5
       - name: Build with mdBook
         run: mdbook build
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
+        uses: actions/upload-pages-artifact@v3
         with:
           path: ./book
 
@@ -61,4 +61,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ This repository contains the source code for "The C++ Programming Language" mdBo
 To build this book you need [mdBook](https://rust-lang.github.io/mdBook/index.html) a tool for creating books with Markdown. mdBook can be installed using Cargo - Rust's package manager.
 
 ```sh
-cargo install mdbook
+cargo install mdbook --vers "0.4.40" --locked
 ```
 
 You can build this book you must clone this repository using Git. You can then build it and even serve it to localhost to view in your browser. The serve command will produce a localhost you can view.
diff --git a/book.toml b/book.toml
@@ -10,7 +10,7 @@ src = "src"
 
 [preprocessor.admonish]
 command = "mdbook-admonish"
-assets_version = "3.0.0"    # do not edit: managed by `mdbook-admonish install`
+assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`
 after = ["links"]
 
 [output.html]
diff --git a/src/SUMMARY.md b/src/SUMMARY.md
@@ -21,178 +21,178 @@
 
 ## Common Programming Concepts
 
-- [Common Programming Concepts](common-concepts/common-concepts.md)
-  - [Variables and Mutability](common-concepts/vars-mut.md)
-  - [Data Types](common-concepts/data-types.md)
-  - [Functions](common-concepts/functions.md)
-  - [Comments](common-concepts/comments.md)
-  - [Control Flow](common-concepts/control-flow.md)
+<!-- - [Common Programming Concepts](common-concepts/common-concepts.md) -->
+<!--   - [Variables and Mutability](common-concepts/vars-mut.md) -->
+<!--   - [Data Types](common-concepts/data-types.md) -->
+<!--   - [Functions](common-concepts/functions.md) -->
+<!--   - [Comments](common-concepts/comments.md) -->
+<!--   - [Control Flow](common-concepts/control-flow.md) -->
 
 ## Ownership
 
-- [Ownership](ownership/ownership.md)
-  - [What is ownership?](ownership/what-is-it.md)
-  - [References and Moves](ownership/refs-moves.md)
-  - [Spans](ownership/spans.md) <!-- and std::string_view -->
+<!-- - [Ownership](ownership/ownership.md) -->
+<!--   - [What is ownership?](ownership/what-is-it.md) -->
+<!--   - [References and Moves](ownership/refs-moves.md) -->
+<!--   - [Spans](ownership/spans.md) <!-- and std::string_view --> -->
 
 ## Containers
 
-- [Containers](containers/containers.md)
-  - [Storing a Sequence of Items with Vectors](containers/vector.md)
-  - [Encoding Text with Strings](containers/string.md)
-  - [Storing Ordered Keys with Associated Values with Maps](containers/map.md)
-  - [Storing Keys with Associated Values with Unordered Maps](containers/unordered_map.md)
-  - [Adapting the Interface of Containers](containers/adaptors.md)
-  - [Storing and Manipulating Individual Bits](containers/bitset.md)
-  - [Multidimensional Representation of Linear Storage](containers/mdspan.md)
+<!-- - [Containers](containers/containers.md) -->
+<!--   - [Storing a Sequence of Items with Vectors](containers/vector.md) -->
+<!--   - [Encoding Text with Strings](containers/string.md) -->
+<!--   - [Storing Ordered Keys with Associated Values with Maps](containers/map.md) -->
+<!--   - [Storing Keys with Associated Values with Unordered Maps](containers/unordered_map.md) -->
+<!--   - [Adapting the Interface of Containers](containers/adaptors.md) -->
+<!--   - [Storing and Manipulating Individual Bits](containers/bitset.md) -->
+<!--   - [Multidimensional Representation of Linear Storage](containers/mdspan.md) -->
 
 ## Error Handling
 
-- [Error Handling](errors/errors.md)
-  - [Compile Time Checks](errors/compile-time-checks.md)
-  - [Exceptions](errors/exceptions.md)
-  - [Stacktraces and Stack Unwinding](errors/stacktraces.md)
-  - [Errors as Values](errors/eav.md)
-  - [Abnormal Termination](errors/abnormal-termination.md)
+<!-- - [Error Handling](errors/errors.md) -->
+<!--   - [Compile Time Checks](errors/compile-time-checks.md) -->
+<!--   - [Exceptions](errors/exceptions.md) -->
+<!--   - [Stacktraces and Stack Unwinding](errors/stacktraces.md) -->
+<!--   - [Errors as Values](errors/eav.md) -->
+<!--   - [Abnormal Termination](errors/abnormal-termination.md) -->
 
 ## Custom Types
 
-- [Custom Types](custom-types/custom-types.md)
-  - [Structuring Related Data](custom-types/structs.md)
-  - [Member Access](custom-types/member-access.md)
-  - [Creating and Using Methods on Structures](custom-types/methods.md)
-  - [Classes](custom-types/classes.md)
-  - [Access Modifiers](custom-types/access-modifiers.md)
-  - [Constructors, Destructors and RAII](custom-types/raii.md)
+<!-- - [Custom Types](custom-types/custom-types.md) -->
+<!--   - [Structuring Related Data](custom-types/structs.md) -->
+<!--   - [Member Access](custom-types/member-access.md) -->
+<!--   - [Creating and Using Methods on Structures](custom-types/methods.md) -->
+<!--   - [Classes](custom-types/classes.md) -->
+<!--   - [Access Modifiers](custom-types/access-modifiers.md) -->
+<!--   - [Constructors, Destructors and RAII](custom-types/raii.md) -->
 
 ## Managing Growing Projects
 
-- [Managing Growing Projects](managing-projects/managing-projects.md)
-  - [Namespaces](managing-projects/namespaces.md)
-  - [Headers](managing-projects/headers.md)
-  - [Modules (C++20)](managing-projects/modules.md)
-  - [CMake](managing-projects/cmake.md)
+<!-- - [Managing Growing Projects](managing-projects/managing-projects.md) -->
+<!--   - [Namespaces](managing-projects/namespaces.md) -->
+<!--   - [Headers](managing-projects/headers.md) -->
+<!--   - [Modules (C++20)](managing-projects/modules.md) -->
+<!--   - [CMake](managing-projects/cmake.md) -->
 
 ## Generic Programming
 
-- [Generic Programming](generics/generics.md)
-  - [Templates](generics/templates.md)
-    - [Template Functions](generics/template-func.md)
-    - [Template Classes](generics/template-classes.md)
-    - [Other Templates](generics/other-templates.md)
-  - [Constraining Templates with Concepts](generics/concepts.md)
-  - [Parameter Packs](generics/param-packs.md)
-  - [Type Erasure](generics/type-erasure.md)
-  - [Sum Types](generics/sum-types.md)
+<!-- - [Generic Programming](generics/generics.md) -->
+<!--   - [Templates](generics/templates.md) -->
+<!--     - [Template Functions](generics/template-func.md) -->
+<!--     - [Template Classes](generics/template-classes.md) -->
+<!--     - [Other Templates](generics/other-templates.md) -->
+<!--   - [Constraining Templates with Concepts](generics/concepts.md) -->
+<!--   - [Parameter Packs](generics/param-packs.md) -->
+<!--   - [Type Erasure](generics/type-erasure.md) -->
+<!--   - [Sum Types](generics/sum-types.md) -->
 
 ## IO
 
-- [IO](io/io.md)
-  - [Streams](io/streams.md)
-  - [Files](io/files.md)
-  - [Formatted String Output (C++20/23)](io/fromatted-strings.md)
+<!-- - [IO](io/io.md) -->
+<!--   - [Streams](io/streams.md) -->
+<!--   - [Files](io/files.md) -->
+<!--   - [Formatted String Output (C++20/23)](io/fromatted-strings.md) -->
 
 ## IO Project
 
-- [Project: IO Project](io/io-project.md)
+<!-- - [Project: IO Project](io/io-project.md) -->
 
 ## Algorithms
 
-- [Algorithms](algorithms/algorithms.md)
-  - [Iterators](algorithms/iterators.md)
-  - [Generic Algorithms](algorithms/generic-algos.md)
-  - [Ranges and Constrained Algorithms](algorithms/ranges.md)
-  - [Views and Composition](algorithms/views.md)
+<!-- - [Algorithms](algorithms/algorithms.md) -->
+<!--   - [Iterators](algorithms/iterators.md) -->
+<!--   - [Generic Algorithms](algorithms/generic-algos.md) -->
+<!--   - [Ranges and Constrained Algorithms](algorithms/ranges.md) -->
+<!--   - [Views and Composition](algorithms/views.md) -->
 
 ## Improved IO Project
 
-- [Project: Improving Our IO Project with Algorithms](algorithms/improved-io-project.md)
+<!-- - [Project: Improving Our IO Project with Algorithms](algorithms/improved-io-project.md) -->
 
 ## Memory
 
-- [Memory](memory/memory.md)
-  - [C++ Memory Model](memory/memory-model.md)
-  - [Stack vs. Heap](memory/stack-vs-heap.md)
-  - [Storage Duration Types](memory/storage-duration-types.md)
-  - [Dynamic Resource Allocation](memory/resources.md)
-    - [Smart Pointers](memory/smart-pointers.md)
-  - [Addresses and Pointers](memory/pointers.md)
-    - [Obtaining an Objects Address](memory/addressof.md)
-    - [Allocators](memory/allocators.md)
-    - [Manual Memory Management](memory/manual-memory.md)
+<!-- - [Memory](memory/memory.md) -->
+<!--   - [C++ Memory Model](memory/memory-model.md) -->
+<!--   - [Stack vs. Heap](memory/stack-vs-heap.md) -->
+<!--   - [Storage Duration Types](memory/storage-duration-types.md) -->
+<!--   - [Dynamic Resource Allocation](memory/resources.md) -->
+<!--     - [Smart Pointers](memory/smart-pointers.md) -->
+<!--   - [Addresses and Pointers](memory/pointers.md) -->
+<!--     - [Obtaining an Objects Address](memory/addressof.md) -->
+<!--     - [Allocators](memory/allocators.md) -->
+<!--     - [Manual Memory Management](memory/manual-memory.md) -->
 
 ## Concurrency
 
-- [Concurrency](concurrency/concurrency.md)
-  - [Running Code Simultaneously](concurrency/basics.md)
-  - [Concurrency vs. Parallelism vs. Asynchronous](concurrency/terminology.md)
-  - [Parallel Algorithms and Execution Policies](concurrency/par-algos.md)
-  - [Threads](concurrency/threads.md)
-  - [Atomics](concurrency/atomics.md)
-  - [Synchronization Techniques](concurrency/sync-techniques.md)
-    - [Semaphores](concurrency/semaphores.md)
-    - [Mutexes](concurrency/mutexes.md)
-    - [Locks](concurrency/locks.md)
-    - [Latches](concurrency/latches.md)
-    - [Barriers](concurrency/barriers.md)
-    - [Conditional Variables](concurrency/cond-vars.md)
-  - [Coroutines](concurrency/coroutines.md)
-  - [Async](concurrency/async.md)
-  - [SIMD](concurrency/simd.md)
-  - [Executors, Senders and Receivers](concurrency/executors-senders-receivers.md)
+<!-- - [Concurrency](concurrency/concurrency.md) -->
+<!--   - [Running Code Simultaneously](concurrency/basics.md) -->
+<!--   - [Concurrency vs. Parallelism vs. Asynchronous](concurrency/terminology.md) -->
+<!--   - [Parallel Algorithms and Execution Policies](concurrency/par-algos.md) -->
+<!--   - [Threads](concurrency/threads.md) -->
+<!--   - [Atomics](concurrency/atomics.md) -->
+<!--   - [Synchronization Techniques](concurrency/sync-techniques.md) -->
+<!--     - [Semaphores](concurrency/semaphores.md) -->
+<!--     - [Mutexes](concurrency/mutexes.md) -->
+<!--     - [Locks](concurrency/locks.md) -->
+<!--     - [Latches](concurrency/latches.md) -->
+<!--     - [Barriers](concurrency/barriers.md) -->
+<!--     - [Conditional Variables](concurrency/cond-vars.md) -->
+<!--   - [Coroutines](concurrency/coroutines.md) -->
+<!--   - [Async](concurrency/async.md) -->
+<!--   - [SIMD](concurrency/simd.md) -->
+<!--   - [Executors, Senders and Receivers](concurrency/executors-senders-receivers.md) -->
 
 ## Metaprogramming
 
-- [Metaprogramming](meta/meta.md)
-  - [Type Traits and SFINAE](meta/type-traits.md)
-  - [Compile Time Computation](meta/comptime.md)
-  - [Index Sequences](meta/index-seqs.md)
+<!-- - [Metaprogramming](meta/meta.md) -->
+<!--   - [Type Traits and SFINAE](meta/type-traits.md) -->
+<!--   - [Compile Time Computation](meta/comptime.md) -->
+<!--   - [Index Sequences](meta/index-seqs.md) -->
 
 ## Numerics and Mathematical Calculations
 
-- [Numerics and Mathematical Calculations](numerics/numerics.md)
-  - [Mathematical Functions](numerics/math-func.md)
-  - [Mathematical Constants](numerics/numbers.md)
-  - [Numerical Limits](numerics/numeric-limits.md)
-  - [Complex Number Type](numerics/complex-numbers.md)
-  <!-- - [Valarray Type](numerics/.md) -->
-  - [Pseudo Random Number Generation](numerics/rand.md)
-  - [Floating Point Environment Control](numerics/fp-env.md)
+<!-- - [Numerics and Mathematical Calculations](numerics/numerics.md) -->
+<!--   - [Mathematical Functions](numerics/math-func.md) -->
+<!--   - [Mathematical Constants](numerics/numbers.md) -->
+<!--   - [Numerical Limits](numerics/numeric-limits.md) -->
+<!--   - [Complex Number Type](numerics/complex-numbers.md) -->
+<!--   - [Valarray Type](numerics/.md) -->
+<!--   - [Pseudo Random Number Generation](numerics/rand.md) -->
+<!--   - [Floating Point Environment Control](numerics/fp-env.md) -->
 
 ## Object Orientated Programming in C++
 
-- [Object Orientated Programming in C++](oop/oop.md)
-  - [Inheritance](oop/inheritance.md)
-  - [Abstract Classes](oop/abstract-classes.md)
+<!-- - [Object Orientated Programming in C++](oop/oop.md) -->
+<!--   - [Inheritance](oop/inheritance.md) -->
+<!--   - [Abstract Classes](oop/abstract-classes.md) -->
 
 ## Working with the Filesystem
 
-- [Working with the Filesystem](fs/fs.md)
-  - [Paths](fs/paths.md)
-  - [Directories](fs/directories.md)
-  - [Utilities](fs/utils.md)
+<!-- - [Working with the Filesystem](fs/fs.md) -->
+<!--   - [Paths](fs/paths.md) -->
+<!--   - [Directories](fs/directories.md) -->
+<!--   - [Utilities](fs/utils.md) -->
 
 ## Date, Time and Localization
 
-- [Date and Time](time/date-time.md)
-  - [Clocks and Time](time/clocks.md)
-  - [Timezones](time/timezones.md)
-  - [Calenders](time/calendars.md)
-  - [Locales](time/locales.md)
+<!-- - [Date and Time](time/date-time.md) -->
+<!--   - [Clocks and Time](time/clocks.md) -->
+<!--   - [Timezones](time/timezones.md) -->
+<!--   - [Calenders](time/calendars.md) -->
+<!--   - [Locales](time/locales.md) -->
 
 ## Regex
 
-- [Regex](regex/regex.md)
+<!-- - [Regex](regex/regex.md) -->
 
 ## Appendix
 
-- [Appendix](appendix/appendicies.md)
-  - [A - Keywords](appendix/keywords.md)
-  - [B - Operators](appendix/operators.md)
-  - [C - Developer Tools](appendix/devtools.md)
-  - [D - Standard Versions](appendix/standard-versions.md)
-  - [E - Value Categories](appendix/value-categories.md)
-  - [F - Compiler Vendors](appendix/compiler-vendors.md)
-  - [G - Compilation Pipeline](appendix/compilation-pipeline.md)
-  - [H - The C++ Runtime](appendix/runtime.md)
-  - [I - Challenge Answers](appendix/callenge-answers.md)
+<!-- - [Appendix](appendix/appendicies.md) -->
+<!--   - [A - Keywords](appendix/keywords.md) -->
+<!--   - [B - Operators](appendix/operators.md) -->
+<!--   - [C - Developer Tools](appendix/devtools.md) -->
+<!--   - [D - Standard Versions](appendix/standard-versions.md) -->
+<!--   - [E - Value Categories](appendix/value-categories.md) -->
+<!--   - [F - Compiler Vendors](appendix/compiler-vendors.md) -->
+<!--   - [G - Compilation Pipeline](appendix/compilation-pipeline.md) -->
+<!--   - [H - The C++ Runtime](appendix/runtime.md) -->
+<!--   - [I - Challenge Answers](appendix/callenge-answers.md) -->
diff --git a/styles/mdbook-admonish.css b/styles/mdbook-admonish.css
