You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/architecture.rst
+21Lines changed: 21 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,3 +24,24 @@ all components.
24
24
The ``guides``, ``guides-markdown`` and ``guides-restructuredtext`` are seen as the main
25
25
libaries of the project. The other components are optional and can be used to extend the
26
26
functionality of the main libraries for specific use cases.
27
+
28
+
Application flow
29
+
================
30
+
31
+
Processing documents is done in a few steps.
32
+
33
+
#. :php:class:`Parsing <\phpDocumentor\Guides\Parser>` The first step is to parse the document. This is done by the :doc:`parser` component. The
34
+
parser component will parse the document and create a tree of nodes. Each node
35
+
represents a part of the document. For example a paragraph, a list or a table.
36
+
#. :php:class:`Compiling <\phpDocumentor\Guides\Compiler\Compiler>` The second step is to compile the tree of nodes. This is done by the :doc:`compiler`
37
+
component. During the compilation modifications can be made to the tree of nodes. For
38
+
example the compiler can add a table of contents to the tree of nodes.
39
+
40
+
#. :php:class:`Rendering <\phpDocumentor\Guides\Renderer\BaseTypeRenderer>` The third step is to render the tree of nodes. This is done by the :doc:`render`
41
+
component. The render component will render the tree of nodes to a specific output
42
+
format. By default twig templates are used to render nodes to HTML. But you can
43
+
create your own templates to render nodes to other formats. Or implement your own
0 commit comments