1. Konrad Anton
  2. sphinx-extensions

Commits

Georg Brandl  committed 958c590

Add node structure picture.

  • Participants
  • Parent commits f87d980
  • Branches default

Comments (0)

Files changed (1)

File doc/ext/tutorial.rst

View file
  • Ignore whitespace
 In the last line, the nodes that should be put into the doctree are returned:
 the target node and the admonition node.
 
+The node structure that the directive returns looks like this::
+
+   +--------------------+
+   | target node        |
+   +--------------------+
+   +--------------------+
+   | todo node          |
+   +--------------------+
+     \__+--------------------+
+        | admonition title   |
+        +--------------------+
+        | paragraph          |
+        +--------------------+
+        | ...                |
+        +--------------------+
+
 
 The Event Handlers
 ------------------