doctrine/archived-doctrine-website
1
0
Fork 0
mirror of https://github.com/doctrine/doctrine-website.git synced 2026-03-23 22:32:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix rendering of rst examples

Browse Source
This commit is contained in:
Claudio Zizza
2025-10-07 14:28:13 +02:00
parent 6fbdd0da66
commit cd438dff80
1 changed files with 176 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

195
source/rst-examples.rst
View File

@@ -1,11 +1,24 @@
RST Examples
============
.. sectionauthor:: Jonathan H. Wage <jonwage@gmail.com>
Versions
--------
..
Code
~~~~
Jonathan H. Wage wrote these examples!
.. code-block:: rst
.. versionadded:: 2.2
This was added new in version 2.2.
.. code-block:: php
echo 'Hello World';
Result
~~~~~~
.. versionadded:: 2.2
@@ -15,21 +28,89 @@ Jonathan H. Wage wrote these examples!
echo 'Hello World';
.. versionadded:: 2.2
Code Examples
-------------
This was added new in version 2.2.
Code
~~~~
.. code-block:: rst
.. code-block:: php
echo 'Hello World';
.. code-block:: rst
.. code-block:: console
echo "Hello World"
Result
~~~~~~
.. code-block:: php
<?php
echo 'Hello World';
.. code-block:: console
echo "Hello World"
.. sectionauthor:: Marco
Boxes
-----
Code
~~~~
.. code-block:: rst
.. caution::
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.
.. code-block:: rst
.. hint::
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.
.. code-block:: rst
.. note::
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.
.. code-block:: rst
.. tip::
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.
.. code-block:: rst
.. warning::
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.
.. code-block:: rst
.. note::
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.
.. versionadded:: 2.4
.. code-block:: php
echo 'Hello World';
.. code-block:: console
echo "Hello World"
Result
~~~~~~
.. caution::
@@ -43,10 +124,6 @@ This was added new in version 2.2.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.
.. notice::
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.
.. tip::
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.
@@ -63,23 +140,51 @@ This was added new in version 2.2.
.. code-block:: php
<?php
echo 'Hello World';
.. code-block:: console
echo "Hello World"
Configuration Block
-------------------
RST
~~~
.. code-block:: rst
.. configuration-block::
.. code-block:: php
echo 'Hello World';
.. code-block:: json
{
"Hello": "World"
}
.. code-block:: sql
SELECT username, active FROM users WHERE username = 'jwage'
.. code-block:: yaml
username: jwage
active: true
Result
~~~~~~
.. configuration-block::
.. code-block:: php
<?php
echo 'Hello World';
.. code-block:: json
{
@@ -98,15 +203,50 @@ This was added new in version 2.2.
Lists
-----
RST
~~~
.. code-block:: rst
- List Item 1
- List Child 1
- List Child 2
- List Item 2
- List Item 3
Result
~~~~~~
- List Item 1
- List Child 1
- List Child 2
- List Child 1
- List Child 2
- List Item 2
- List Item 3
Grid Tables
-----------
RST
~~~
.. code-block:: rst
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
+========================+============+==========+==========+
| body row 1, column 1 | column 2 | column 3 | column 4 |
+------------------------+------------+----------+----------+
| body row 2 | ... | ... | |
+------------------------+------------+----------+----------+
Result
~~~~~~
+------------------------+------------+----------+----------+
| Header row, column 1 | Header 2 | Header 3 | Header 4 |
| (header rows optional) | | | |
@@ -119,6 +259,23 @@ Grid Tables
Simple Tables
-------------
RST
~~~
.. code-block:: rst
===== ===== =======
A B A and B
===== ===== =======
False False False
True False False
False True False
True True True
===== ===== =======
Result
~~~~~~
===== ===== =======
A B A and B
===== ===== =======