Skip to content

Commit 8ca2fa7

Browse files
committed
[BUGFIX] Fix diverse rendering warnings
Add documents that were referenced but not included
1 parent a7237d6 commit 8ca2fa7

File tree

4 files changed

+41
-20
lines changed

4 files changed

+41
-20
lines changed

docs/architecture.rst

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,15 @@ Architecture
33
============
44

55
The project is built around the core library that is called ``guides``. This library
6-
contains all core components of the project. Like the different layers :doc:`parser`,
7-
:doc:`compiler` and :doc:`render` and includes the basic Nodes and templates to create
8-
output.
6+
contains all core components of the project. Like the different layers :ref:`parser-component`,
7+
:ref:`compiler-component` and :ref:`renderer-component` and includes the basic
8+
Nodes and templates to create output.
99

10-
Installation of the core library can be done using ``composer``::
10+
Installation of the core library can be done using ``composer``:
1111

12-
.. code:: bash
13-
composer require phpdocumentor/guides
12+
.. code-block:: bash
13+
14+
composer require phpdocumentor/guides
1415
1516
The other components are using the core library and extend it with additional
1617
functionality. For example the ``guides-markdown`` component adds support for
@@ -30,18 +31,21 @@ Application flow
3031

3132
Processing documents is done in a few steps.
3233

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
44-
renderer to use a different template engine.
34+
#. :php:class:`Parsing <\phpDocumentor\Guides\Parser>` The first step is to parse the document.
35+
This is done by the :ref:`parser-component`. The
36+
parser component will parse the document and create a tree of nodes. Each node
37+
represents a part of the document. For example a paragraph, a list or a table.
38+
#. :php:class:`Compiling <\phpDocumentor\Guides\Compiler\Compiler>` The second step is to compile the tree of nodes.
39+
This is done by the :ref:`compiler-component`
40+
component. During the compilation, modifications can be made to the tree of nodes. For
41+
example the compiler can add a table of contents to the tree of nodes.
42+
43+
#. :php:class:`Rendering <\phpDocumentor\Guides\Renderer\BaseTypeRenderer>`
44+
The third step is to render the tree of nodes. This is done by the :ref:`renderer-component`
45+
component. The render component will render the tree of nodes to a specific output
46+
format. By default twig templates are used to render nodes to HTML. But you can
47+
create your own templates to render nodes to other formats. Or implement your own
48+
renderer to use a different template engine.
4549

4650
.. uml:: _uml/application-flow.puml
4751
:caption: Application flow

docs/components/parser.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. include:: /include.rst.txt
2+
3+
.. _parser-component:
4+
5+
======
6+
Parser
7+
======
8+
9+
.. warning:: This needs to be documented

docs/components/renderer.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
.. include:: /include.rst.txt
2+
3+
.. _renderer-component:
4+
5+
========
6+
Renderer
7+
========
8+
9+
.. warning:: This needs to be documented

docs/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,8 @@ If you are looking for a complete solution to create a documentation website the
4444

4545
installation
4646
cli/index
47+
components/index
4748
developers/index
4849
architecture
4950
reference/index
5051
contributions/index
51-
about
52-
contributions/index

0 commit comments

Comments
 (0)