Put examples under 'getting started'

dyninst · Apr 3, 2024 · 83d6f06 · 83d6f06
1 parent 76413e4
commit 83d6f06
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 13 deletions.
diff --git a/docs/examples/index.rst b/docs/examples/index.rst
@@ -0,0 +1,16 @@
+Examples
+########
+
+.. toctree::
+  :caption: examples
+  :name: examples
+  :hidden:
+  :maxdepth: 2
+
+  symtab-add-type
+  binary_analysis
+  cfg
+  function_disassembly
+  instrument_function
+  memory_access
+  retee
diff --git a/docs/examples/symtab-add-type.rst b/docs/examples/symtab-add-type.rst
@@ -0,0 +1,12 @@
+.. _`example:symtab-add-type`:
+
+Add new user type
+#################
+
+New user-defined types can be added to a :cpp:class:`Symtab <SymtabAPI::Symtab>` object. The
+following example shows both how to query type information after an
+object file is successfully parsed and also add a new structure type.
+
+.. rli:: https://raw.githubusercontent.com/dyninst/examples/master/symtabAPI/addType.cpp
+  :language: cpp
+  :linenos:
diff --git a/docs/index.rst b/docs/index.rst
@@ -88,6 +88,7 @@ Developed by
    basics/building
    basics/using
    basics/first_mutator
+   examples/index
 
 .. toctree::
    :caption: toolkit overviews
@@ -105,19 +106,6 @@ Developed by
    symtabAPI/overview
    usertools/DynC/overview
 
-.. toctree::
-   :caption: examples
-   :name: examples
-   :hidden:
-   :maxdepth: 2
-
-   examples/binary_analysis
-   examples/cfg
-   examples/function_disassembly
-   examples/instrument_function
-   examples/memory_access
-   examples/retee
-
 .. toctree::
    :caption: toolkit api docs
    :name: apis