Skip to content
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.

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

#312: fix documentation CI #320

Merged
merged 1 commit into from
Feb 20, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/md/checkpoint_learn_example_2.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
The full code for this *checkpoint* example can be found here:
`examples/checkpoint_example_2.cc`

\subsubsection ex Example source code:
\subsubsection ex2 Example source code:
\snippet examples/checkpoint_example_2.cc Serialize custom structure

2 changes: 1 addition & 1 deletion docs/md/checkpoint_learn_example_2_nonintrusive.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
The full code for this *checkpoint* example can be found here:
`examples/checkpoint_example_2_nonintrusive.cc`

\subsubsection ex Example source code:
\subsubsection ex2 Example source code:
\snippet examples/checkpoint_example_2_nonintrusive.cc Non-Intrusive Serialize custom structure

2 changes: 1 addition & 1 deletion docs/md/checkpoint_learn_example_3_nonintrusive.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
The full code for this *checkpoint* example can be found here:
`examples/checkpoint_example_3_nonintrusive.cc`

\subsubsection ex Example source code:
\subsubsection ex3 Example source code:
\snippet examples/checkpoint_example_3_nonintrusive.cc Non-Intrusive Serialize constraints constructor destructor
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
\page ckpt_learn_example_polymorphic_macro_nonintrusive Non-Intrusive Polymorphic Serialization Example w/Macros
\page ckpt_learn_ex6_polymorphic_macro_nonintrusive Non-Intrusive Polymorphic Serialization Example w/Macros

\attention All Non-Intrusive serialize methods <b>MUST</b> be placed in the namespace of type which they serialize.

The full code for this *checkpoint* example can be found here:
`examples/checkpoint_example_polymorphic_macro_nonintrusive.cc`

\subsubsection ex Example source code:
\subsubsection ex6 Example source code:
\snippet examples/checkpoint_example_polymorphic_macro_nonintrusive.cc Non-Intrusive Serialize polymorphic macro
4 changes: 2 additions & 2 deletions docs/md/checkpoint_learn_example_polymorphic_nonintrusive.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
\page ckpt_learn_example_polymorphic_nonintrusive Non-Intrusive Polymorphic Serialization Example
\page ckpt_learn_ex5_polymorphic_nonintrusive Non-Intrusive Polymorphic Serialization Example

\attention All Non-Intrusive serialize methods <b>MUST</b> be placed in the namespace of type which they serialize.

The full code for this *checkpoint* example can be found here:
`examples/checkpoint_example_polymorphic_nonintrusive.cc`

\subsubsection ex Example source code:
\subsubsection ex5 Example source code:
\snippet examples/checkpoint_example_polymorphic_nonintrusive.cc Non-Intrusive Serialize polymorphic
4 changes: 2 additions & 2 deletions docs/md/checkpoint_learn_example_to_file.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
\page ckpt_learn_ex_tofile Program Example Serialize To File
\page ckpt_learn_ex4_tofile Program Example Serialize To File

One potential application for this approach is to generate a restart file
for a simulation.

The full code for this example can be found here:
`examples/checkpoint_example_to_file.cc`

\subsubsection ex Example source code:
\subsubsection ex4 Example source code:
\snippet examples/checkpoint_example_to_file.cc Serialize structure to file
4 changes: 2 additions & 2 deletions docs/md/checkpoint_learn_example_to_file_nonintrusive.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
\page ckpt_learn_ex_tofile_nonintrusive Non-Intrusive Program Example Serialize To File
\page ckpt_learn_ex4_tofile_nonintrusive Non-Intrusive Program Example Serialize To File

\attention All Non-Intrusive serialize methods <b>MUST</b> be placed in the namespace of type which they serialize.

Expand All @@ -8,5 +8,5 @@ for a simulation.
The full code for this example can be found here:
`examples/checkpoint_example_to_file_nonintrusive.cc`

\subsubsection ex Example source code:
\subsubsection ex4 Example source code:
\snippet examples/checkpoint_example_to_file_nonintrusive.cc Non-Intrusive Serialize structure to file
4 changes: 2 additions & 2 deletions docs/md/checkpoint_learn_example_traversal.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
\page ckpt_learn_ex_traversal Program Example Traversal
\page ckpt_learn_ex7_traversal Program Example Traversal

The full code for this *checkpoint* example can be found here:
`examples/checkpoint_example_traversal.cc`

\subsubsection ex Example source code:
\subsubsection ex7 Example source code:
\snippet examples/checkpoint_example_traversal.cc Serialization with custom traverser

4 changes: 2 additions & 2 deletions docs/md/checkpoint_learn_example_traversal_nonintrusive.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
\page ckpt_learn_ex_traversal_nonintrusive Non-Intrusive Program Example Traversal
\page ckpt_learn_ex7_traversal_nonintrusive Non-Intrusive Program Example Traversal

\attention All Non-Intrusive serialize methods <b>MUST</b> be placed in the namespace of type which they serialize.

The full code for this *checkpoint* example can be found here:
`examples/checkpoint_example_traversal_nonintrusive.cc`

\subsubsection ex Example source code:
\subsubsection ex7 Example source code:
\snippet examples/checkpoint_example_traversal_nonintrusive.cc Non-Intrusive Serialization with custom traverser

16 changes: 8 additions & 8 deletions docs/md/checkpoint_learn_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
| checkpoint_example_1 | Serialization of a structure | \subpage ckpt_learn_ex1 |
| checkpoint_example_2 | Serialization of a custom structure | \subpage ckpt_learn_ex2 |
| checkpoint_example_3 | Illustrate needs for constructor/destructor | \subpage ckpt_learn_ex3 |
| checkpoint_example_to_file | Serialize / deserialize structure to file | \subpage ckpt_learn_ex_tofile |
| checkpoint_example_polymorphic | Serialization of polymorphic class hierarchy | \subpage ckpt_learn_example_polymorphic |
| checkpoint_example_polymorphic_macro | Serialization of polymorphic class hierarchy with macros | \subpage ckpt_learn_example_polymorphic_macro |
| checkpoint_example_traversal | Serialization with custom traverser | \subpage ckpt_learn_ex_traversal |
| checkpoint_example_4_to_file | Serialize / deserialize structure to file | \subpage ckpt_learn_ex4_tofile |
| checkpoint_example_5_polymorphic | Serialization of polymorphic class hierarchy | \subpage ckpt_learn_ex5_polymorphic |
| checkpoint_example_6_polymorphic_macro | Serialization of polymorphic class hierarchy with macros | \subpage ckpt_learn_ex6_polymorphic_macro |
| checkpoint_example_7_traversal | Serialization with custom traverser | \subpage ckpt_learn_ex7_traversal |

&nbsp;
&nbsp;
Expand All @@ -21,7 +21,7 @@ Please do not put serialize methods in global magistrate namespace.
| checkpoint_example_1 | Serialization of a structure | \subpage ckpt_learn_ex1_nonintrusive |
| checkpoint_example_2 | Serialization of a custom structure | \subpage ckpt_learn_ex2_nonintrusive |
| checkpoint_example_3 | Illustrate needs for constructor/destructor | \subpage ckpt_learn_ex3_nonintrusive |
| checkpoint_example_to_file | Serialize / deserialize structure to file | \subpage ckpt_learn_ex_tofile_nonintrusive |
| checkpoint_example_polymorphic | Serialization of polymorphic class hierarchy | \subpage ckpt_learn_example_polymorphic_nonintrusive |
| checkpoint_example_polymorphic_macro | Serialization of polymorphic class hierarchy with macros | \subpage ckpt_learn_example_polymorphic_macro_nonintrusive |
| checkpoint_example_traversal | Serialization with custom traverser | \subpage ckpt_learn_ex_traversal_nonintrusive |
| checkpoint_example_4_to_file | Serialize / deserialize structure to file | \subpage ckpt_learn_ex4_tofile_nonintrusive |
| checkpoint_example_5_polymorphic | Serialization of polymorphic class hierarchy | \subpage ckpt_learn_ex5_polymorphic_nonintrusive |
| checkpoint_example_6_polymorphic_macro | Serialization of polymorphic class hierarchy with macros | \subpage ckpt_learn_ex6_polymorphic_macro_nonintrusive |
| checkpoint_example_7_traversal | Serialization with custom traverser | \subpage ckpt_learn_ex7_traversal_nonintrusive |
2 changes: 1 addition & 1 deletion docs/shared/checkpoint_learn_example_polymorphic.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
\page ckpt_learn_example_polymorphic Polymorphic Serialization Example
\page ckpt_learn_ex5_polymorphic Polymorphic Serialization Example

The full code for this *checkpoint* example can be found here:
`examples/checkpoint_example_polymorphic.cc`
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/checkpoint_learn_example_polymorphic_macro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
\page ckpt_learn_example_polymorphic_macro Polymorphic Serialization Example w/Macros
\page ckpt_learn_ex6_polymorphic_macro Polymorphic Serialization Example w/Macros

The full code for this *checkpoint* example can be found here:
`examples/checkpoint_example_polymorphic_macro.cc`
Expand Down
2 changes: 1 addition & 1 deletion docs/shared/checkpoint_learn_serialize.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ hierarchy so it can automatically traverse the hierarchy. Alternatively, the
user may use the inheritance wrappers `checkpoint::SerializableBase<T>` and
`checkpoint::SerializableDerived<T, U>` to achieve the same effect.

The example in \ref ckpt_learn_example_polymorphic_macro illustrates the
The example in \ref ckpt_learn_ex6_polymorphic_macro illustrates the
approach uses the macros. The example in \ref ckpt_learn_example_polymorphic
illustrates this approach.

Expand Down
Loading