ceedling 1.0.0 → 1.1.0

data/docs/ReleaseNotes.md

@@ -1,13 +1,142 @@
 # 🌱 Ceedling Release Notes
 
-These release notes are complemented by two other documents:
+These release notes are complemented by three other documents:
 
 1. 🪵 **[Changelog](Changelog.md)** for a structured list of additions, fixes, changes, and removals.
-1. 💔 **[Breaking Changes](BreakingChanges.md)** for a list of impacts to existing Ceedling projects.
+2. 💔 **[Breaking Changes](BreakingChanges.md)** for a list of impacts to existing Ceedling projects.
+3. 🐛 **[Known Issues](KnownIssues.md)** for a list of presently known problems and limitations.
 
 ---
 
-# 1.0.0 pre-release — November 28, 2024
+# 1.1.0 — July 16, 2026
+
+## 👀 Highlights
+
+1.1.0 adds several significant new features plus incorporates a number of bug fixes and other improvements. See [Changelog](Changelog.md) for a full list of new features, bug fixes, and improvements.
+
+The incomplete list of goodies:
+
+* A [Partial][partials-docs] allows a test to mix mocked and real functions from the same source module in a single test file and enables testing of `static` and `inline` functions without modifying source code.
+* Ceedling is now complemented by a full, searchable [documentation site][ceedling-docs-site] available both online and as a local bundle exported from Ceedling’s command line.
+* More and expanded [example projects][example-projects].
+* New stock plugins for [Valgrind memory checking][valgrind-plugin] and [Cppcheck static analysis][cppcheck-plugin].
+* The [GCov plugin][gcov-plugin]:
+   * _Finally_ supports coverage reports for all sources.
+   * Adds support for Modified Condition / Decision Coverage.
+* Mixins improvements including an option for [inline YAML at the command line][mixins-inline-yaml].
+* Test preprocessing has undergone significant improvements (again) and is faster, more robust, and handles more testing needs.
+* Ceedling’s test preprocessing is once again compatible with Unity’s parameterized test cases (support was temporarily removed with 1.0.0).
+* Helpful logging at start up flagging automatic configuration changes or problematic combinations of settings.
+* Integrates latest [Unity](https://github.com/ThrowTheSwitch/Unity) ([2.7.0](https://github.com/ThrowTheSwitch/Unity/blob/master/docs/UnityChangeLog.md)).
+* Integrates latest [CMock](https://github.com/ThrowTheSwitch/CMock) ([2.7.0](https://github.com/ThrowTheSwitch/CMock/blob/master/docs/CMockChangeLog.md)).
+
+[partials-docs]: https://throwtheswitch.github.io/Ceedling/1.1.0/testing-guide/partials/
+[example-projects]: https://throwtheswitch.github.io/Ceedling/latest/getting-started/example-projects/
+[ceedling-docs-site]: https://throwtheswitch.github.io/Ceedling/
+[valgrind-plugin]: https://throwtheswitch.github.io/Ceedling/1.1.0/plugins/valgrind/
+[cppcheck-plugin]: https://throwtheswitch.github.io/Ceedling/1.1.0/plugins/cppcheck/
+[gcov-plugin]: https://throwtheswitch.github.io/Ceedling/1.1.0/plugins/gcov/
+[mixins-inline-yaml]: https://throwtheswitch.github.io/Ceedling/latest/configuration/mixins/?h=mixins#-mixin-command-line-flags
+
+## 🔢 Ruby version support
+
+Ceedling 1.1.0 is known to work well across all versions of Ruby 3.0 – 3.4 on Linux, Windows, and macOS. Ruby 2.x support was removed with 1.1.0.
+
+Ceedling 1.1.0 also passes all internal tests for Ruby 3.5, but it has not yet been thoroughly exercised with Ruby 3.5 in the real world.
+
+To avoid Ruby version and installation environment complications, consider using [the readymade MadScienceLab Docker images](https://throwtheswitch.github.io/Ceedling/1.1.0/getting-started/installation/#madsciencelab-docker-images).
+
+## 📖 Configuration Cheatsheet for 1.1.0 Changes
+
+The following is not a complete project configuration. But, for those already familiar with Ceedling, this cheatsheet illustrates some of the important changes in this latest release of Ceedling through the lens of a project configuration. To be clear, more has changed than what is referenced in this YAML blurb (see the Changelog).
+
+```yaml
+:project:
+  # When TRUE enables a significant new set of testing abilities (see Partials documentation).
+  # Because this feature depends on test preprocessing and uses mocking, it automatically
+  # enables those settings, overriding any user settings disabling them.
+  :use_partials: FALSE
+
+:test_build:
+  # This configuration option is primarily to enable internal prepocessing fallback handling
+  # measures when certain toolchain preprocessing features are unavailable.
+  # This option is unlikely to be needed in real-world use but in rare edge cases it could 
+  # ovverride a false positive when toolchain preprocessing features are probed.
+  :preprocess_force_fallback: FALSE
+
+:plugins:
+  :enabled:
+    # (See config blurb below)
+    - gcov
+
+    # New Valgrind plugin to run test suites with memory checking and reporting
+    - valgrind
+    
+    # New Cppcheck static analysis reporting plugin
+    - cppcheck
+
+:gcov:
+  # The Gcov plugin now supports Modified Condition / Decision Coverage reporting.
+  # These abilities require GCC 14+ and optionally GCovr 8.6+.
+  :mcdc: FALSE
+
+  # The Gcov plugin now offers options for processing coverage for all sources in the project.
+  # Untested sources can be optionally compiled with coverage for 0% coverage entries in the final report.
+  # - :warn (default) logs all untested sources that are not in a coverage report.
+  # - :ignore entirely omits any handling of untested sources.
+  # - :compile attempts to compile all untested sources for coverage tracking.
+  #   Note: Compilation may require additional defines, flags, and stand-in headers/symbols.
+  :untested_sources: :warn
+
+```
+
+## 📣 Shout-outs and Special Thank-You’s
+
+### Sponsors
+
+- [ThingamaByte, LLC](https://thingamabyte.com) — For continuing to nurture these projects and community with so much of their time.
+- [Infineon Technologies AG](https://www.infineon.com/) — For sponsoring the long-awaited [Partials][partials-doc] features.
+
+### Major Code/Doc Contributors
+
+These individuals contributed significant features, bugfixes, and improvements.
+
+- Michael Karlesky
+- Mark VanderVoord
+- Roland Stahn
+- Alejandro Rosso
+- Ross Smyth
+- burakutkuc
+- ml-physec
+- Cory Todd
+- Gavin Dunlap
+- Dariqq
+- James Browning
+- David Beitey
+- savashn
+- bal-stan
+- aditya
+- Marquez, Humberto
+
+### Also, thanks for your contributions!
+
+Artem Sharipov, Christer Fletcher, Costas Akrivoulis, Crt Mori, Dominik Loidolt, Ivan Kravets, Jacques Boivin, 
+James Raphael Tiovalen, Joshua Stone, Kiran Phalak, Lucas Saavedra Vaz, Matt Sullivan, Matthew Biddlestone, 
+Michael Dwan, Peter Backeman, Roland Marchand, pikammmmm, yahyayozo
+
+---
+
+# 1.0.1 - January 30, 2025
+
+This is a collection of bugfixes found after the 1.0.0 release. If you are upgrading from a pre-1.0 release of Ceedling, we highly recommend reading the `1.0.0` release notes as well!
+
+See [Changelog](Changelog.md) for a full list of bug fixes and improvements.
+
+The most significant issues addressed with this release are problems with preprocessor handling, particularly when discovering which header files are required for each test. If you were running into similar problems with `1.0.0`, we highly recommend this upgrade.
+
+---
+
+# 1.0.0 — January 01, 2025
 
 **This Ceedling release is probably the most significant since the project was first [posted to SourceForge in 2009][sourceforge].**
 
@@ -15,7 +144,7 @@ Ceedling now runs in Ruby 3. Builds can now run much faster than previous versio
 
 * See all the [Highlights](#-highlights) below for an overview of everything in this big release.
 * See the [Changelog](Changelog.md) for a detailed list of new features, fixes, and changes in this release.
-* We’ve included below a [project configuration cheatsheet](#-project-configuration-cheatsheet-for-100-changes) for those already familiar with Ceedling that want to understand the various configuration changes.
+* We’ve included below a [project configuration cheatsheet](#-configuration-cheatsheet-for-100-changes) for those already familiar with Ceedling that want to understand the various configuration changes.
 
 ## 🏴‍☠️ Avast, Breaking Changes, Ye Scallywags!
 
@@ -77,7 +206,7 @@ Kalle Møller, Peter Kempter, Luca Cavalli, Maksim Chichikalov, Marcelo Jo, Matt
 Olivier C. Larocque, Patrick Little, Richard Eklycke, Serjche, Spencer Russell, Stavros Vagionitis, Steven Huang,
 Toby Mole, Tom Hotston, Yuanqing Liu, afacotti, ccarrizosa, diachini, Steven Willard
 
-## 📖 Project Configuration Cheatsheet for 1.0.0 Changes
+## 📖 Configuration Cheatsheet for 1.0.0 Changes
 
 The following is not a complete project configuration. But, for those already familiar with Ceedling, this cheatsheet illustrates some of the important changes in this latest release of Ceedling through the lens of a project configuration.
 
@@ -228,18 +357,18 @@ Ever wanted to smoosh in some extra configuration selectively? Let’s say you h
 All such features have been superseded by _Mixins_. Mixins are simply additional YAML that gets merged into you base project configuration. However, Mixins provide several key improvements over previous features:
 
 1. Mixins can be as little or as much configuration as you want. You could push all your configuration into mixins with a base project file including nothing but a `:mixins` section.
-1. Mixins can be specified in your project configuration, via environment variables, and from the command line. A clear order of precedence controls the order of merging. Any conflicts or duplicates are automatically resolved.
-1. Logging makes clear what proejct file and mixins are loaded and merged at startup.
-1. Like built-in plugins, Ceedling will soon come with built-in mixins available for common build scenarios.
+2. Mixins can be specified in your project configuration, via environment variables, and from the command line. A clear order of precedence controls the order of merging. Any conflicts or duplicates are automatically resolved.
+3. Logging makes clear what proejct file and mixins are loaded and merged at startup.
+4. Like built-in plugins, Ceedling will soon come with built-in mixins available for common build scenarios.
 
 #### A proper command line
 
 Until this release, Ceedling depended on Rake for most of its command line handling. Rake’s task conventions provide poor command line handling abilities. The core problems with Rake command line handling include:
 
 1. Only brief, limited help statements.
-1. No optional flags to modify a task — verbosity, logging, etc. were their own tasks.
-1. Complex/limited parameterization (e.g. `verbosity[3]` instead of `--verbosity normal`).
-1. Tasks are order-dependent. So, for example, `test:all verbosity[5]` changes verbosity after the tests are run.
+2. No optional flags to modify a task — verbosity, logging, etc. were their own tasks.
+3. Complex/limited parameterization (e.g. `verbosity[3]` instead of `--verbosity normal`).
+4. Tasks are order-dependent. So, for example, `test:all verbosity[5]` changes verbosity after the tests are run.
 
 Ceedling now offers a full command line interface with rich help, useful order-independent option flags, and more.
 
@@ -253,7 +382,7 @@ Try `ceedling help` and then `ceedling help <command>` to get started.
 * The `build` keyword is assumed by Ceedling. That is, it’s optional. `ceedling test:all` is the same as `ceedling build test:all`. The `build` keyword handling tells the Ceedling application to execute the named build task dynamically generated from your project configuration. 
 * In the transition to remove Rake from Ceedling, two categories of command line interactions now exist. Note this distinction in the `help` headings.
    1. **Application Commands** — `help`, `build`, `new`, `upgrade`, `environment`, `examples`, `example`, `dumpconfig`, and `version`. These have full help via `ceedling help <command>` and a variety of useful command line switches that conform to typical command line conventions.
-   1. **Build & Plugin Tasks** — Operations dynamically generated from your project configuration. These have only summary help (listed in `ceedling help`) and work just as they previously did. Common command line tasks including `ceedling test:all` and `ceedling release` are in this category.
+   2. **Build & Plugin Tasks** — Operations dynamically generated from your project configuration. These have only summary help (listed in `ceedling help`) and work just as they previously did. Common command line tasks including `ceedling test:all` and `ceedling release` are in this category.
 
 ### Medium Deal Highlights 🥈
 
@@ -314,13 +443,6 @@ There’s more to be done, but Ceedling’s documentation is more complete and a
 
 Together, these changes may cause you to think that Ceedling is running steps out of order or duplicating work. While bugs are always possible, more than likely, the output you see and the build ordering is expected.
 
-## 🩼 Known Issues
-
-1. The new internal pipeline that allows builds to be parallelized and configured per-test-executable can mean a fair amount of duplication of steps. A header file may be mocked identically multiple times. The same source file may be compiled identically multiple times. The speed gains due to parallelization help make up for this. Future releases will concentrate on optimizing away duplication of build steps.
-1. While header file search paths are now customizable per executable, this currently only applies to the search paths the compiler uses. Distinguishing test files or header files of the same name in different directories for test runner and mock generation respectively continues to rely on educated guesses in Ceedling code.
-1. Any path for a C file specified with `TEST_SOURCE_FILE(...)` is in relation to **_project root_** — that is, from where you execute `ceedling` at the command line. If you move source files or change your directory structure, many of your `TEST_SOURCE_FILE(...)` calls may need to be updated. A more flexible and dynamic approach to path handling will come in a future update.
-1. Ceedling’s many test preprocessing improvements are not presently able to preserve Unity’s special `TEST_CASE()` and `TEST_RANGE()` features. However, preprocessing of test files is much less frequently needed than preprocessing of mockable header files. Test preprocessing can now be configured to enable only one or the other. As such, these advanced Unity features can still be used in even sophisticated projects.
-
 ## 📚 Background Knowledge
 
 ### Parallel execution of build steps

data/docs/SECURITY.md

@@ -0,0 +1,41 @@
+# Security Policies and Procedures
+
+This document outlines security procedures and general policies for all `ThrowTheSwitch.org`
+projects, including `Unity`, `CMock`, and `Ceedling`.
+
+  * [Reporting a Bug](#reporting-a-bug)
+  * [Disclosure Policy](#disclosure-policy)
+  * [Comments on this Policy](#comments-on-this-policy)
+
+## Reporting a Bug
+
+The tools from `ThrowTheSwitch.org` are made to collaborate with other tools like compilers, 
+simulators, and such, and therefore have very low-level access to the world they live in. 
+However, they are typically used in controlled development-centered environments. As such, 
+they are typically not directly exposed to security concerns. 
+
+The `ThrowTheSwitch.org` community takes security bugs seriously. Where possible, we will
+make every effort to improve our tools safe use. Thank you for improving the security of 
+our tools. We appreciate your efforts and responsible disclosure and will make every effort 
+to acknowledge your contributions.
+
+Report security bugs by opening a Github Issue on the corresponding project or (when this
+itself would pose a risk) by emailing security@thingamabyte.com.
+
+Report security bugs in third-party modules to the person or team maintaining
+the module.
+
+## Disclosure Policy
+
+Each issue will be assigned to a primary handler. This person will coordinate the fix and 
+release process, involving the following steps:
+
+  * Confirm the problem and determine the affected versions.
+  * Audit code to find any potential similar problems.
+  * Prepare fixes for all releases still under maintenance. These fixes will be
+    released as fast as possible.
+
+## Comments on this Policy
+
+If you have suggestions on how this process could be improved please submit a
+pull request.

data/docs/mkdocs/assets/images/ceedling.svg

@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="97.133911mm"
+   height="30.976776mm"
+   viewBox="0 0 97.133911 30.976776"
+   id="SVGRoot"
+   version="1.1"
+   inkscape:version="1.3 (0e150ed, 2023-07-21)"
+   sodipodi:docname="ceedling.svg"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     inkscape:document-units="mm"
+     inkscape:zoom="1.6099916"
+     inkscape:cx="282.61017"
+     inkscape:cy="98.758279"
+     id="namedview1"
+     pagecolor="#ffffff"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     inkscape:window-width="2384"
+     inkscape:window-height="1205"
+     inkscape:window-x="63"
+     inkscape:window-y="36"
+     inkscape:window-maximized="0"
+     inkscape:current-layer="layer1" />
+  <defs
+     id="defs1">
+    <rect
+       x="74.475204"
+       y="65.034683"
+       width="205.06905"
+       height="106.46807"
+       id="rect2" />
+    <rect
+       x="14.685251"
+       y="36.713127"
+       width="250.17374"
+       height="118.00648"
+       id="rect1" />
+  </defs>
+  <g
+     inkscape:label="Layer 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-6.0213221,-4.1692327)">
+    <text
+       xml:space="preserve"
+       style="font-size:20.9022px;font-family:'Hoefler Text';-inkscape-font-specification:'Hoefler Text';letter-spacing:-0.734842px;fill:#40b04f;stroke:#3fb03f;stroke-width:0.185157;stroke-dasharray:none"
+       x="33.266129"
+       y="30.390062"
+       id="text2-5"
+       transform="scale(1.0182432,0.98208365)"><tspan
+         sodipodi:role="line"
+         id="tspan1-8"
+         style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Euphemia UCAS';-inkscape-font-specification:'Euphemia UCAS';letter-spacing:-0.734842px;fill:#000000;fill-opacity:1;stroke:#000000;stroke-width:0.185157;stroke-dasharray:none;stroke-opacity:1"
+         x="33.266129"
+         y="30.390062"
+         dx="0">eedling</tspan></text>
+    <ellipse
+       style="fill:#3fb04e;fill-opacity:1;stroke:#3fb04e;stroke-width:0.185157;stroke-dasharray:none;stroke-opacity:1"
+       id="path3"
+       cx="74.850098"
+       cy="15.453616"
+       rx="1.1163616"
+       ry="1.0767177" />
+    <path
+       fill="#2ba52e"
+       d="m 28.238853,15.163619 -0.0071,-0.0049 c -0.188853,-0.133042 -0.450726,-0.286254 -0.753292,-0.416102 -0.605166,-0.259158 -1.357066,-0.349122 -2.057014,-0.197424 -0.700385,0.149723 -1.349173,0.539246 -1.795965,1.016971 -0.223164,0.239851 -0.399812,0.483081 -0.517921,0.679017 a 3.2459831,3.2133734 0 0 0 -0.08457,0.145019 c -0.04097,0.01719 -0.08246,0.0357 -0.123655,0.05695 -0.163345,0.08031 -0.333874,0.181362 -0.496536,0.308777 -0.163423,0.126388 -0.322068,0.274922 -0.469923,0.440899 -0.148787,0.165542 -0.281703,0.351121 -0.404511,0.545383 -0.123709,0.194178 -0.22942,0.400821 -0.32464,0.610739 l -0.06948,0.158159 -0.0625,0.159866 -0.03107,0.07982 -0.02779,0.08036 -0.05513,0.160212 c -0.01726,0.05343 -0.03264,0.107 -0.0489,0.160163 -0.01538,0.0533 -0.03339,0.105974 -0.0463,0.159054 l -0.0096,0.03667 c -0.08132,-0.120087 -0.16897,-0.231845 -0.262279,-0.332707 -0.106447,-0.115003 -0.21852,-0.217353 -0.332371,-0.30783 -0.228188,-0.180847 -0.464929,-0.309832 -0.683258,-0.401284 a 2.8950941,2.8660091 0 0 0 -0.35343,-0.118983 l 0.0017,-0.0055 h 2.7e-5 v -2.7e-5 h -2.7e-5 c 0,0 -0.105872,-0.07563 -0.27389,-0.16046 -0.169271,-0.08812 -0.400465,-0.184713 -0.662361,-0.257777 -0.523711,-0.145667 -1.148517,-0.136933 -1.703857,0.06368 -0.555914,0.199073 -1.042862,0.588539 -1.3548,1.028002 -0.155696,0.220543 -0.272932,0.438735 -0.347638,0.61185 l -0.0024,0.0051 c -0.07391,0.166921 -0.0035,0.362695 0.160282,0.445927 l 0.0064,0.0032 c 0.169272,0.0881 0.400468,0.184715 0.662365,0.25778 0.523711,0.145666 1.148516,0.136934 1.703856,-0.06369 0.555918,-0.199045 1.042863,-0.588511 1.354801,-1.028004 a 3.7240782,3.6866654 0 0 0 0.185085,-0.290578 1.9697697,1.9499811 0 0 1 0.25933,0.08958 c 0.14578,0.0639 0.30396,0.152562 0.455722,0.276518 0.07563,0.06206 0.669714,0.676475 0.669714,1.385102 a 1.8979311,1.8788641 0 0 1 0.03346,0.365859 l -0.0034,0.470508 -0.007,0.962187 -0.03707,5.15846 v 0.0075 c 0.0021,0.29147 1.068292,0.283953 1.066186,-0.0075 l -0.03707,-5.15846 -0.0027,-0.378596 c 0.0052,-0.02679 0.0078,-0.05452 0.0074,-0.08286 l -0.0034,-0.298043 -6.83e-4,-0.07444 0.001,-0.07826 0.0027,-0.176306 c 7.8e-5,-0.06265 0.0038,-0.130714 0.0069,-0.202211 0.0036,-0.07144 0.0055,-0.14691 0.01083,-0.225086 l 0.01801,-0.243824 c 0.0067,-0.0842 0.0174,-0.170491 0.02624,-0.259699 0.02023,-0.177847 0.04658,-0.36448 0.0814,-0.55555 l 0.01255,-0.07215 0.0151,-0.07191 0.03052,-0.14548 c 0.0093,-0.04919 0.02338,-0.09691 0.03494,-0.145909 0.01237,-0.04868 0.02386,-0.098 0.03704,-0.146859 l 0.04251,-0.146045 0.02133,-0.07344 0.0243,-0.07231 0.04864,-0.145209 0.05468,-0.142637 c 0.07498,-0.189097 0.15859,-0.37454 0.256896,-0.546223 0.09749,-0.171977 0.202815,-0.335681 0.320435,-0.47959 0.116854,-0.144532 0.241573,-0.272949 0.369409,-0.382275 0.127232,-0.110405 0.260092,-0.197234 0.387135,-0.267703 0.04714,-0.02764 0.09486,-0.04975 0.140999,-0.07112 0.181972,0.121844 0.41874,0.25575 0.687849,0.371239 0.605135,0.259158 1.357066,0.349123 2.057014,0.197425 0.700385,-0.149753 1.349174,-0.539273 1.795962,-1.01697 0.223164,-0.239879 0.399812,-0.48311 0.517921,-0.679045 l 0.0036,-0.0058 c 0.116281,-0.188662 0.06384,-0.435028 -0.119312,-0.561389 z"
+       id="path1-7"
+       style="stroke-width:0.0271774" />
+    <path
+       id="path1-3"
+       style="font-size:85.3333px;font-family:'Hoefler Text';-inkscape-font-specification:'Hoefler Text';white-space:pre;fill:#808080;fill-opacity:1;stroke:none;stroke-width:0.925786"
+       d="m 29.274701,22.299607 c -10.226342,0.116398 -9.130894,3.15799 -16.917817,1.29735 3.481625,4.654552 6.591085,4.673606 8.7809,4.885028 5.83196,-0.325414 6.786081,-2.548121 9.531302,-6.181068 -0.664304,-0.01452 -0.730842,-0.02612 -1.394385,-0.0013 z"
+       sodipodi:nodetypes="ccccc" />
+    <path
+       id="path7"
+       style="fill:none;fill-opacity:1;stroke:#000000;stroke-width:1.94415;stroke-dasharray:none;stroke-opacity:1"
+       d="m 32.384773,21.667847 a 11.845839,11.425172 0 0 1 -2.300778,3.707001 v 0 A 11.845839,11.425172 0 0 1 13.357505,26.27562 11.845839,11.425172 0 0 1 12.423571,10.143116 11.845839,11.425172 0 0 1 29.150062,9.2423456 11.845839,11.425172 0 0 1 32.566804,14.370973" />
+  </g>
+</svg>

data/docs/mkdocs/assets/stylesheets/admonitions.css

@@ -0,0 +1,152 @@
+/* Restore older style of Admonitions (nicer) */
+
+.md-typeset .admonition,
+.md-typeset details {
+  border-width: 0;
+  border-left-width: 4px;
+}
+
+/* 
+ Styling Built-In Admonition Types
+ =================================
+ */
+
+/* ── Note ──────────────────────────────────────────────────────────────────
+   Usage:  !!! note "This does not imply if the swallow is African or European"
+               Body text here.
+   ────────────────────────────────────────────────────────────────────────── */
+
+/* Overrides default note style.
+  */
+.md-typeset .admonition.note,
+.md-typeset details.note {
+  border-color: rgb(58, 0, 64);
+}
+
+.md-typeset .note > .admonition-title,
+.md-typeset .note > summary {
+  background-color: rgba(58, 0, 64, .15);
+}
+
+.md-typeset .note > .admonition-title::before,
+.md-typeset .note > summary::before {
+  background-color: rgb(58, 0, 64);
+}
+
+/* ── Tip ──────────────────────────────────────────────────────────────────
+   Usage:  !!! tip "You pronounce it 'potato'"
+               Body text here.
+   ────────────────────────────────────────────────────────────────────────── */
+
+/* Overrides default tip style.
+  */
+.md-typeset .admonition.tip,
+.md-typeset details.tip {
+  border-color: rgb(58, 0, 64);
+}
+
+.md-typeset .tip > .admonition-title,
+.md-typeset .tip > summary {
+  background-color: rgba(58, 0, 64, .15);
+}
+
+.md-typeset .tip > .admonition-title::before,
+.md-typeset .tip > summary::before {
+  background-color: rgb(58, 0, 64);
+}
+
+/* ── Info ──────────────────────────────────────────────────────────────────
+   Usage:  !!! info "The answer to Life, The Universe, and Everything is 42."
+               Body text here.
+   ────────────────────────────────────────────────────────────────────────── */
+
+/* Overrides default info style.
+  */
+.md-typeset .admonition.info,
+.md-typeset details.info {
+  border-color: rgb(58, 0, 64);
+}
+
+.md-typeset .info > .admonition-title,
+.md-typeset .info > summary {
+  background-color: rgba(58, 0, 64, .15);
+}
+
+.md-typeset .info > .admonition-title::before,
+.md-typeset .info > summary::before {
+  background-color: rgb(58, 0, 64);
+}
+
+/* 
+ Custom Admonition Types
+ =======================
+ */
+
+/* ── Sponsorship ────────────────────────────────────────────────────────────
+   Usage:  !!! sponsorship "ThingamaByte is a Great Sponsor"
+               Body text here.
+   ────────────────────────────────────────────────────────────────────────── */
+
+/* Icon: Material Design Icons 'currency-usd'
+   Source: material/templates/.icons/material/currency-usd.svg
+   (Only available at time of site-generation in a container)
+
+   CSS mask-image requires an SVG data URL but the :material-currency-usd: shortcode
+   is Markdown-only and is not available to CSS.
+  
+   The SVG path recreates the 'currency-usd' icon from Material Design Icons as
+   the file is unavailable outside the site-generation container.
+  */
+:root {
+  --md-admonition-icon--sponsorship: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M11.8,10.9c-2.27-0.59-3-1.2-3-2.15c0-1.09,1.01-1.85,2.7-1.85c1.78,0,2.44,0.85,2.5,2.1h2.21c-0.07-1.72-1.12-3.3-3.21-3.81V3h-3v2.16c-1.94,0.42-3.5,1.68-3.5,3.61c0,2.31,1.91,3.46,4.7,4.13c2.5,0.6,3,1.48,3,2.41c0,0.69-0.49,1.79-2.7,1.79c-2.06,0-2.87-0.92-2.98-2.1h-2.2c0.12,2.19,1.76,3.42,3.68,3.83V21h3v-2.15c1.95-0.37,3.5-1.5,3.5-3.55C17.5,12.46,14.07,11.49,11.8,10.9z'/></svg>");
+}
+
+.md-typeset .admonition.sponsorship,
+.md-typeset details.sponsorship {
+  border-color: rgb(63, 176, 78);
+}
+
+.md-typeset .sponsorship > .admonition-title,
+.md-typeset .sponsorship > summary {
+  background-color: rgb(91,255,113);
+}
+
+.md-typeset .sponsorship > .admonition-title::before,
+.md-typeset .sponsorship > summary::before {
+  background-color: rgb(63, 176, 78);
+  -webkit-mask-image: var(--md-admonition-icon--sponsorship);
+          mask-image: var(--md-admonition-icon--sponsorship);
+}
+
+/* ── Feature ────────────────────────────────────────────────────────────────
+   Usage:  !!! feature "New in 1.0"
+               Body text here.
+   ────────────────────────────────────────────────────────────────────────── */
+
+/* Icon: Custom 16-point starburst badge (no MDI equivalent)
+   A circular "new and improved" badge seal with 16 short ridged points.
+   Constructed by alternating outer radius 11 and inner radius 9 at 11.25° steps.
+
+   CSS mask-image requires an SVG data URL; Markdown icon shortcodes are
+   not available to CSS.
+  */
+:root {
+  --md-admonition-icon--feature: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M12,1L13.76,3.17L16.21,1.84L17,4.52L19.78,4.22L19.48,7L22.16,7.79L20.83,10.24L23,12L20.83,13.76L22.16,16.21L19.48,17L19.78,19.78L17,19.48L16.21,22.16L13.76,20.83L12,23L10.24,20.83L7.79,22.16L7,19.48L4.22,19.78L4.52,17L1.84,16.21L3.17,13.76L1,12L3.17,10.24L1.84,7.79L4.52,7L4.22,4.22L7,4.52L7.79,1.84L10.24,3.17Z'/></svg>");
+}
+
+.md-typeset .admonition.feature,
+.md-typeset details.feature {
+  border-color: rgb(63, 176, 78);
+}
+
+.md-typeset .feature > .admonition-title,
+.md-typeset .feature > summary {
+  background-color: rgb(91,255,113);
+}
+
+.md-typeset .feature > .admonition-title::before,
+.md-typeset .feature > summary::before {
+  background-color: rgb(63, 176, 78);
+  -webkit-mask-image: var(--md-admonition-icon--feature);
+          mask-image: var(--md-admonition-icon--feature);
+}

data/docs/mkdocs/assets/stylesheets/fixes-local.css

@@ -0,0 +1,15 @@
+/* sidebar logo and style */
+/* Fix sidebar scrollwrap overflow from bad JS height calculation.
+   We can't set site_url for the local site, and this causes the header height to be miscalculated.
+ */
+.md-sidebar {
+    top: 2.4rem !important;
+}
+.md-sidebar__scrollwrap {
+    height: calc(100vh - 2.4rem) !important;  /* 100vh minus header height */
+    overflow-y: auto;
+}
+.md-nav--primary .md-nav__title {
+    background-color: #EEEEEE !important;
+    font-size: 0;
+}

data/docs/mkdocs/assets/stylesheets/styling.css

@@ -0,0 +1,102 @@
+/*-------------------------------------------------
+ * Header logo and style
+ *------------------------------------------------*/
+/* .md-header {
+    background-color: #EEEEEE;
+}
+.md-header__title {
+  display: none;
+}
+.md-header__button.md-logo {
+  margin: 0;
+  padding: 0;
+}
+.md-header__button.md-logo img,
+.md-header__button.md-logo svg {
+  height: 2.0rem;
+}
+@media screen and (max-width: 76.1875em) {
+  .md-header__button.md-logo {
+    display: flex; // force it to stay visible
+  }
+} */
+
+/*-------------------------------------------------
+ * Header element ordering
+ * Reorder so hamburger + search appear before the logo
+ *------------------------------------------------*/
+/* .md-header__button[for="__drawer"] { order: 1; }
+.md-header__button[for="__search"] { order: 2; }
+.md-search                         { order: 3; }
+.md-header__title                  { order: 4; }
+.md-version                        { order: 5; }
+.md-header__source                 { order: 6; }
+.md-header__button.md-logo         { order: 7; margin-left: auto; } */
+
+/*-------------------------------------------------
+ * Search bar
+ *------------------------------------------------*/
+/* .md-search {
+    flex: none;
+}
+.md-search__form {
+    background-color: #DDDDDD;
+    border-radius: 4px;
+}
+.md-search__input {
+    color: #3A0040; // Replace with your desired color
+}
+.md-search__input::placeholder {
+    color: #3A0040;
+}
+.md-search__icon {
+    color: #3A0040;
+} */
+
+/*-------------------------------------------------
+ * Repository display
+ *------------------------------------------------*/
+/* .md-header__inner {
+    padding-right: 0 !important;
+}
+.md-header__source {
+    background-color: #3A0040;
+    border-radius: 4px;
+    padding: 0 ; // 0.5rem;
+}
+.md-source__repository {
+  color: #3fb04e;
+  font-weight: bold;
+}
+.md--source__facts {
+  color: #3fb04e;
+  font-size: 0.7rem;
+} */
+
+/*-------------------------------------------------
+ * Navigation section separators
+ *------------------------------------------------*/
+
+ /* Separator around nested subsections only */
+.md-nav__item--section .md-nav__item--section {
+  border-top: 1px solid var(--md-default-fg-color--lightest);
+  margin-top: 0.6rem;
+  padding-top: 0.6rem;
+}
+
+/* No bottom border on last subsection */
+.md-nav__item--section .md-nav__item--section:last-child {
+  border-bottom: none;
+}
+
+/* Bottom border only on subsections that aren't last */
+.md-nav__item--section .md-nav__item--section:not(:last-child) {
+  border-bottom: 1px solid var(--md-default-fg-color--lightest);
+  margin-bottom: 0.6rem;
+  padding-bottom: 0.6rem;
+}
+
+/* Add breathing room inside subsection before the bottom border */
+.md-nav__item--section .md-nav__item--section:not(:last-child) > .md-nav {
+  padding-bottom: 0.6rem;
+}

data/docs/mkdocs/configuration/environment-vars.md

@@ -0,0 +1,14 @@
+# Environment Variables
+
+Ceedling recognizes several environment variables that control its behavior
+independently of your project configuration file.
+
+These handful of environment variables fall into two categories:
+
+1. Options for loading your project configuration.
+1. Controlling logging output styling.
+
+See the [Environment Variables Reference](../reference/environment-vars.md)
+for the full listing of all recognized variables and their accepted values.
+
+<br/><br/>