Fix Jekyll docs build error from curly braces interpretation (#2951)

* Fix Jekyll docs build error from curly braces interpretation * fix spelling
nasa · Oct 15, 2024 · d43fe50 · d43fe50
1 parent 0ea1744
commit d43fe50
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txt
@@ -268,6 +268,7 @@ endcond
 endfunction
 endloc
 endmacro
+endraw
 enduml
 ENQUEUEX
 enumchan

diff --git a/docs/HowTo/develop-subtopologies.md b/docs/HowTo/develop-subtopologies.md
@@ -264,6 +264,7 @@ topology MainDeployment {
 
 At this point, we want to now call our subtopology's configure/start/teardown functions within the corresponding functions of our `MainDeployment` topology. So, in `MainDeploymentTopology.cpp`:
 
+<!-- {% raw %} -->
 ```cpp
 // at the top, include our topology.hpp
 #include <MySubtopology/MySubtopologyTopology.hpp>
@@ -293,6 +294,7 @@ void teardownTopology(const TopologyState& state){
     MySubtopology::teardownTopology({})
 }
 ```
+<!-- {% endraw %} -->
 
 Lastly, since our RNG component has some telemetry, we need to include (or ignore) these channels within the `Packets.xml` file in this folder. As with any other component that is added to a deployment, you use the same syntax with the name of the instance followed by the name of the telemetry channel. For example: