From 35599f9a6671779a377443ae6e596367a7613e22 Mon Sep 17 00:00:00 2001 From: Nicholas Chin Date: Tue, 21 Feb 2023 19:41:06 -0700 Subject: 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 Part 2: Submitting a patch to coreboot.org Part 3: Writing unit tests Managing local additions Flashing firmware ``` 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 Reviewed-on: https://review.coreboot.org/c/coreboot/+/73158 Reviewed-by: Matt DeVillier Tested-by: build bot (Jenkins) --- Documentation/drivers/index.md | 18 +++++++++++------- Documentation/drivers/smmstore.md | 6 +++++- Documentation/drivers/smmstorev2.md | 6 +++++- 3 files changed, 21 insertions(+), 9 deletions(-) (limited to 'Documentation/drivers') diff --git a/Documentation/drivers/index.md b/Documentation/drivers/index.md index 95c1e312a0..9b7d25ca23 100644 --- a/Documentation/drivers/index.md +++ b/Documentation/drivers/index.md @@ -8,10 +8,14 @@ For details on how to connect device drivers to a mainboard, see [Driver Devicet Some of the drivers currently available include: -* [Intel DPTF](dptf.md) -* [IPMI KCS](ipmi_kcs.md) -* [SMMSTORE](smmstore.md) -* [SMMSTOREv2](smmstorev2.md) -* [SoundWire](soundwire.md) -* [USB4 Retimer](retimer.md) -* [CBFS SMBIOS hooks](cbfs_smbios.md) +```{toctree} +:maxdepth: 1 + +Intel DPTF +IPMI KCS +SMMSTORE +SMMSTOREv2 +SoundWire +USB4 Retimer +CBFS SMBIOS hooks +``` diff --git a/Documentation/drivers/smmstore.md b/Documentation/drivers/smmstore.md index 70827477df..d68e51c43d 100644 --- a/Documentation/drivers/smmstore.md +++ b/Documentation/drivers/smmstore.md @@ -128,7 +128,11 @@ data or modify the currently running kernel.* ## External links -* [A Tour Beyond BIOS Implementing UEFI Authenticated Variables in SMM with EDKI](https://software.intel.com/sites/default/files/managed/cf/ea/a_tour_beyond_bios_implementing_uefi_authenticated_variables_in_smm_with_edkii.pdf) +```{toctree} +:maxdepth: 1 + +A Tour Beyond BIOS Implementing UEFI Authenticated Variables in SMM with EDKI +``` Note, this differs significantly from coreboot's implementation. [SMM]: ../security/smm.md diff --git a/Documentation/drivers/smmstorev2.md b/Documentation/drivers/smmstorev2.md index 70aa60d4ac..03d3c7c659 100644 --- a/Documentation/drivers/smmstorev2.md +++ b/Documentation/drivers/smmstorev2.md @@ -215,7 +215,11 @@ running kernel. ## External links -* [A Tour Beyond BIOS Implementing UEFI Authenticated Variables in SMM with EDKI](https://software.intel.com/sites/default/files/managed/cf/ea/a_tour_beyond_bios_implementing_uefi_authenticated_variables_in_smm_with_edkii.pdf) +```{toctree} +:maxdepth: 1 + +A Tour Beyond BIOS Implementing UEFI Authenticated Variables in SMM with EDKI +``` Note that this differs significantly from coreboot's implementation. [SMM]: ../security/smm.md -- cgit v1.2.3