diff options
author | Nicholas Chin <nic.c3.14@gmail.com> | 2023-02-21 19:41:06 -0700 |
---|---|---|
committer | Martin L Roth <gaumless@gmail.com> | 2024-03-21 16:11:56 +0000 |
commit | 35599f9a6671779a377443ae6e596367a7613e22 (patch) | |
tree | c765d9b3404c7d1b3d72c780f62f7ff3e18adbad /Documentation/mainboard/system76 | |
parent | 9203e25a3539a3a1e55ea12b3bfa4d15f0aa0304 (diff) |
Docs: Replace Recommonmark with MyST Parser
Recommonmark has been deprecated since 2021 [1] and the last release was
over 3 years ago [2]. As per their announcement, Markedly Structured
Text (MyST) Parser [3] is the recommended replacement.
For the most part, the existing documentation is compatible with MyST,
as both parsers are built around the CommonMark flavor of Markdown. The
main difference that affects coreboot is how the Sphinx toctree is
generated. Recommonmark has a feature called auto_toc_tree, which
converts single level lists of references into a toctree:
* [Part 1: Starting from scratch](part1.md)
* [Part 2: Submitting a patch to coreboot.org](part2.md)
* [Part 3: Writing unit tests](part3.md)
* [Managing local additions](managing_local_additions.md)
* [Flashing firmware](flashing_firmware/index.md)
MyST Parser does not provide a replacement for this feature, meaning the
toctree must be defined manually. This is done using MyST's syntax for
Sphinx directives:
```{toctree}
:maxdepth: 1
Part 1: Starting from scratch <part1.md>
Part 2: Submitting a patch to coreboot.org <part2.md>
Part 3: Writing unit tests <part3.md>
Managing local additions <managing_local_additions.md>
Flashing firmware <flashing_firmware/index.md>
```
Internally, auto_toc_tree essentially converts lists of references into
the Sphinx toctree structure that the MyST syntax above more directly
represents.
The toctrees were converted to the MyST syntax using the following
command and Python script:
`find ./ -iname "*.md" | xargs -n 1 python conv_toctree.py`
```
import re
import sys
in_list = False
f = open(sys.argv[1])
lines = f.readlines()
f.close()
with open(sys.argv[1], "w") as f:
for line in lines:
match = re.match(r"^[-*+] \[(.*)\]\((.*)\)$", line)
if match is not None:
if not in_list:
in_list = True
f.write("```{toctree}\n")
f.write(":maxdepth: 1\n\n")
f.write(match.group(1) + " <" + match.group(2) + ">\n")
else:
if in_list:
f.write("```\n")
f.write(line)
in_list = False
if in_list:
f.write("```\n")
```
While this does add a little more work for creating the toctree, this
does give more control over exactly what goes into the toctree. For
instance, lists of links to external resources currently end up in the
toctree, but we may want to limit it to pages within coreboot.
This change does break rendering and navigation of the documentation in
applications that can render Markdown, such as Okular, Gitiles, or the
GitHub mirror. Assuming the docs are mainly intended to be viewed after
being rendered to doc.coreboot.org, this is probably not an issue in
practice.
Another difference is that MyST natively supports Markdown tables,
whereas with Recommonmark, tables had to be written in embedded rST [4].
However, MyST also supports embedded rST, so the existing tables can be
easily converted as the syntax is nearly identical.
These were converted using
`find ./ -iname "*.md" | xargs -n 1 sed -i "s/eval_rst/{eval-rst}/"`
Makefile.sphinx and conf.py were regenerated from scratch by running
`sphinx-quickstart` using the updated version of Sphinx, which removes a
lot of old commented out boilerplate. Any relevant changes coreboot had
made on top of the previous autogenerated versions of these files were
ported over to the newly generated file.
From some initial testing the generated webpages appear and function
identically to the existing documentation built with Recommonmark.
TEST: `make -C util/docker docker-build-docs` builds the documentation
successfully and the generated output renders properly when viewed in
a web browser.
[1] https://github.com/readthedocs/recommonmark/issues/221
[2] https://pypi.org/project/recommonmark/
[3] https://myst-parser.readthedocs.io/en/latest/
[4] https://doc.coreboot.org/getting_started/writing_documentation.html
Change-Id: I0837c1722fa56d25c9441ea218e943d8f3d9b804
Signed-off-by: Nicholas Chin <nic.c3.14@gmail.com>
Reviewed-on: https://review.coreboot.org/c/coreboot/+/73158
Reviewed-by: Matt DeVillier <matt.devillier@gmail.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
Diffstat (limited to 'Documentation/mainboard/system76')
29 files changed, 30 insertions, 30 deletions
diff --git a/Documentation/mainboard/system76/addw1.md b/Documentation/mainboard/system76/addw1.md index 332070a959..5d5dae346c 100644 --- a/Documentation/mainboard/system76/addw1.md +++ b/Documentation/mainboard/system76/addw1.md @@ -44,7 +44,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/addw2.md b/Documentation/mainboard/system76/addw2.md index a5015de65c..9a302a2ecc 100644 --- a/Documentation/mainboard/system76/addw2.md +++ b/Documentation/mainboard/system76/addw2.md @@ -43,7 +43,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+-----------------+ | Type | Value | +=====================+=================+ diff --git a/Documentation/mainboard/system76/addw3.md b/Documentation/mainboard/system76/addw3.md index c964351914..dccd6301c0 100644 --- a/Documentation/mainboard/system76/addw3.md +++ b/Documentation/mainboard/system76/addw3.md @@ -48,7 +48,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/bonw14.md b/Documentation/mainboard/system76/bonw14.md index 2ea866b78e..cc94f39b21 100644 --- a/Documentation/mainboard/system76/bonw14.md +++ b/Documentation/mainboard/system76/bonw14.md @@ -53,7 +53,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/bonw15.md b/Documentation/mainboard/system76/bonw15.md index db32efe26f..63c00d9b61 100644 --- a/Documentation/mainboard/system76/bonw15.md +++ b/Documentation/mainboard/system76/bonw15.md @@ -42,7 +42,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/darp6.md b/Documentation/mainboard/system76/darp6.md index 364301495e..152727f18f 100644 --- a/Documentation/mainboard/system76/darp6.md +++ b/Documentation/mainboard/system76/darp6.md @@ -40,7 +40,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+-----------------+ | Type | Value | +=====================+=================+ diff --git a/Documentation/mainboard/system76/darp7.md b/Documentation/mainboard/system76/darp7.md index d1dee864b9..06cf03445e 100644 --- a/Documentation/mainboard/system76/darp7.md +++ b/Documentation/mainboard/system76/darp7.md @@ -42,7 +42,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/darp8.md b/Documentation/mainboard/system76/darp8.md index 4d2da37876..1dadc4f3ca 100644 --- a/Documentation/mainboard/system76/darp8.md +++ b/Documentation/mainboard/system76/darp8.md @@ -40,7 +40,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ @@ -59,7 +59,7 @@ | External flashing | yes | +---------------------+---------------------+ ``` -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/darp9.md b/Documentation/mainboard/system76/darp9.md index b0f156695a..f7d299dbd2 100644 --- a/Documentation/mainboard/system76/darp9.md +++ b/Documentation/mainboard/system76/darp9.md @@ -39,7 +39,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/galp4.md b/Documentation/mainboard/system76/galp4.md index aa661fec88..bd8919cb90 100644 --- a/Documentation/mainboard/system76/galp4.md +++ b/Documentation/mainboard/system76/galp4.md @@ -42,7 +42,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+-----------------+ | Type | Value | +=====================+=================+ diff --git a/Documentation/mainboard/system76/galp5.md b/Documentation/mainboard/system76/galp5.md index 82840502e3..440e387f9a 100644 --- a/Documentation/mainboard/system76/galp5.md +++ b/Documentation/mainboard/system76/galp5.md @@ -45,7 +45,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/galp6.md b/Documentation/mainboard/system76/galp6.md index e519dc3770..a6c103e3d1 100644 --- a/Documentation/mainboard/system76/galp6.md +++ b/Documentation/mainboard/system76/galp6.md @@ -38,7 +38,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/galp7.md b/Documentation/mainboard/system76/galp7.md index 3d27716957..41624ca5dc 100644 --- a/Documentation/mainboard/system76/galp7.md +++ b/Documentation/mainboard/system76/galp7.md @@ -35,7 +35,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/gaze15.md b/Documentation/mainboard/system76/gaze15.md index facdae63f7..45e4e2674c 100644 --- a/Documentation/mainboard/system76/gaze15.md +++ b/Documentation/mainboard/system76/gaze15.md @@ -51,7 +51,7 @@ make ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/gaze16.md b/Documentation/mainboard/system76/gaze16.md index d8bc7ca02c..a680a5cb9a 100644 --- a/Documentation/mainboard/system76/gaze16.md +++ b/Documentation/mainboard/system76/gaze16.md @@ -64,7 +64,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/gaze17.md b/Documentation/mainboard/system76/gaze17.md index cf7f0a2d9b..1456f9fcbb 100644 --- a/Documentation/mainboard/system76/gaze17.md +++ b/Documentation/mainboard/system76/gaze17.md @@ -39,7 +39,7 @@ The gaze17 comes in 2 variants: gaze17-3050 and gaze17-3060-b. ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/gaze18.md b/Documentation/mainboard/system76/gaze18.md index fe564e8ebb..5c3212a575 100644 --- a/Documentation/mainboard/system76/gaze18.md +++ b/Documentation/mainboard/system76/gaze18.md @@ -49,7 +49,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/lemp10.md b/Documentation/mainboard/system76/lemp10.md index 89e57b5225..b0888af2ce 100644 --- a/Documentation/mainboard/system76/lemp10.md +++ b/Documentation/mainboard/system76/lemp10.md @@ -40,7 +40,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/lemp11.md b/Documentation/mainboard/system76/lemp11.md index f05d63a197..acb791bb49 100644 --- a/Documentation/mainboard/system76/lemp11.md +++ b/Documentation/mainboard/system76/lemp11.md @@ -39,7 +39,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/lemp12.md b/Documentation/mainboard/system76/lemp12.md index 55a2e35cc2..a095bad6c8 100644 --- a/Documentation/mainboard/system76/lemp12.md +++ b/Documentation/mainboard/system76/lemp12.md @@ -39,7 +39,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/lemp9.md b/Documentation/mainboard/system76/lemp9.md index 9739484820..c21618860d 100644 --- a/Documentation/mainboard/system76/lemp9.md +++ b/Documentation/mainboard/system76/lemp9.md @@ -52,7 +52,7 @@ make ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+------------+ | Type | Value | +=====================+============+ diff --git a/Documentation/mainboard/system76/oryp10.md b/Documentation/mainboard/system76/oryp10.md index 921585cb2b..40872e3d66 100644 --- a/Documentation/mainboard/system76/oryp10.md +++ b/Documentation/mainboard/system76/oryp10.md @@ -46,7 +46,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/oryp11.md b/Documentation/mainboard/system76/oryp11.md index ad0a54e496..bd86632e9f 100644 --- a/Documentation/mainboard/system76/oryp11.md +++ b/Documentation/mainboard/system76/oryp11.md @@ -43,7 +43,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/oryp5.md b/Documentation/mainboard/system76/oryp5.md index 662581cf18..bfde6c0289 100644 --- a/Documentation/mainboard/system76/oryp5.md +++ b/Documentation/mainboard/system76/oryp5.md @@ -47,7 +47,7 @@ make ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/oryp6.md b/Documentation/mainboard/system76/oryp6.md index 2c1975e621..6a52c54281 100644 --- a/Documentation/mainboard/system76/oryp6.md +++ b/Documentation/mainboard/system76/oryp6.md @@ -37,7 +37,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+-----------------+ | Type | Value | +=====================+=================+ diff --git a/Documentation/mainboard/system76/oryp7.md b/Documentation/mainboard/system76/oryp7.md index 4672d67bd5..6496aea96d 100644 --- a/Documentation/mainboard/system76/oryp7.md +++ b/Documentation/mainboard/system76/oryp7.md @@ -48,7 +48,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+-----------------+ | Type | Value | +=====================+=================+ diff --git a/Documentation/mainboard/system76/oryp8.md b/Documentation/mainboard/system76/oryp8.md index cfd59d0e77..53eb446096 100644 --- a/Documentation/mainboard/system76/oryp8.md +++ b/Documentation/mainboard/system76/oryp8.md @@ -47,7 +47,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+-----------------+ | Type | Value | +=====================+=================+ diff --git a/Documentation/mainboard/system76/oryp9.md b/Documentation/mainboard/system76/oryp9.md index 87e176b860..33ccf00b17 100644 --- a/Documentation/mainboard/system76/oryp9.md +++ b/Documentation/mainboard/system76/oryp9.md @@ -44,7 +44,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ diff --git a/Documentation/mainboard/system76/serw13.md b/Documentation/mainboard/system76/serw13.md index 6b56a39afa..0695c8f5e5 100644 --- a/Documentation/mainboard/system76/serw13.md +++ b/Documentation/mainboard/system76/serw13.md @@ -46,7 +46,7 @@ ## Flashing coreboot -```eval_rst +```{eval-rst} +---------------------+---------------------+ | Type | Value | +=====================+=====================+ |