Skip to content

Commit dc17550

Browse files
committed
[BUGFIX] Fix diverse rendering warnings
Add documents that were referenced but not included
1 parent 9c4c42d commit dc17550

File tree

5 files changed

+30
-22
lines changed

5 files changed

+30
-22
lines changed

docs/architecture.rst

Lines changed: 23 additions & 19 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
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 Nodes and templates to create
88
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.
45-
46-
.. uml:: _uml/application-flow.puml
34+
#. :php:class:`Parsing <\phpDocumentor\Guides\Parser>` The first step is to parse the document.
35+
This is done by the :ref:`parser-component` 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>` The third step is to render
44+
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.
49+
50+
.. uml:: _uml/application-flow.puml
4751
:caption: Application flow

docs/components/parser.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@
66
Parser
77
======
88

9-
.. warning:: This needs to be documented
9+
.. warning::
10+
This needs to be documented

docs/components/renderer.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@
66
Renderer
77
========
88

9-
.. warning:: This needs to be documented
9+
.. warning::
10+
This needs to be documented

docs/developers/extensions/text-roles.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. include:: /include.rst.txt
22

3+
.. _custom_text_roles:
4+
35
==========
46
Text Roles
57
==========

docs/reference/restructuredtext/text-roles.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Text Roles
66

77
Text roles can be used to style content inline. Some text roles have advanced processing such as reference resolving.
88

9-
You can also :doc:`add your own custom text roles </extension/text-roles>`.
9+
You can also :ref:`add your own custom text roles <custom_text_roles>`.
1010

1111
Currently the following text roles are implemented:
1212

0 commit comments

Comments
 (0)