documentation: Fix evaluation of reStructuredText

eval_rst isn't a valid directive. Use eval-rst instead. Also, add curly
braces where necessary since the MyST parser requires them.

Change-Id: I68337354e9bd4de4b2c29d4e42c3bb22337fbe06
Signed-off-by: Felix Singer <felixsinger@posteo.net>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/83117
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Reviewed-by: Angel Pons <th3fanbus@gmail.com>
Reviewed-by: Nicholas Chin <nic.c3.14@gmail.com>
This commit is contained in:
Felix Singer 2024-06-18 16:57:01 +02:00 committed by Felix Held
parent 1eccf77a78
commit 37c8c85b30
3 changed files with 6 additions and 6 deletions

View File

@ -99,7 +99,7 @@ To reference documents use the TOC tree or inline RST code.
Under Sphinx markdown tables are not supported. Therefore you can use following Under Sphinx markdown tables are not supported. Therefore you can use following
code block to write tables in reStructuredText and embed them into the markdown: code block to write tables in reStructuredText and embed them into the markdown:
```eval_rst ```{eval-rst}
+------------+------------+-----------+ +------------+------------+-----------+
| Header 1 | Header 2 | Header 3 | | Header 1 | Header 2 | Header 3 |
+============+============+===========+ +============+============+===========+
@ -144,7 +144,7 @@ you'll see the following warning:
You can import CSV files and let sphinx automatically convert them to human You can import CSV files and let sphinx automatically convert them to human
readable tables, using the following reStructuredText snipped: readable tables, using the following reStructuredText snipped:
```eval_rst ```{eval-rst}
.. csv-table:: .. csv-table::
:header: "Key", "Value" :header: "Key", "Value"
:file: keyvalues.csv :file: keyvalues.csv

View File

@ -17,7 +17,7 @@ clip to read and flash the chip.
![8560w_chip_location](8560w_flash.webp) ![8560w_chip_location](8560w_flash.webp)
```eval_rst ```{eval-rst}
+---------------------+------------+ +---------------------+------------+
| Type | Value | | Type | Value |
+=====================+============+ +=====================+============+
@ -61,7 +61,7 @@ clip to read and flash the chip.
## Technology ## Technology
```eval_rst ```{eval-rst}
+------------------+--------------------------------------------------+ +------------------+--------------------------------------------------+
| Northbridge | :doc:`../../northbridge/intel/sandybridge/index` | | Northbridge | :doc:`../../northbridge/intel/sandybridge/index` |
+------------------+--------------------------------------------------+ +------------------+--------------------------------------------------+

View File

@ -14,7 +14,7 @@ therefore the automatic fan control will not increase the fan speed.
## Flashing coreboot ## Flashing coreboot
```{eval_rst} ```{eval-rst}
+---------------------+-------------------------+ +---------------------+-------------------------+
| Type | Value | | Type | Value |
+=====================+=========================+ +=====================+=========================+
@ -82,7 +82,7 @@ until cleanly power cycled.
## Technology ## Technology
```{eval_rst} ```{eval-rst}
+------------------+--------------------------------------------------+ +------------------+--------------------------------------------------+
| Northbridge | :doc:`../../northbridge/intel/sandybridge/index` | | Northbridge | :doc:`../../northbridge/intel/sandybridge/index` |
+------------------+--------------------------------------------------+ +------------------+--------------------------------------------------+