From 544411ab6a1d8f30c4efc7dfbc8fb47f9ea6c58e Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Mon, 14 Sep 2026 11:25:05 +0200 Subject: [PATCH] [TASK] Bring the reST markup to the documented house style The guide asks for `.. note::` with two spaces after the dots and a body one level deeper, and for one indentation level to be four spaces. Two files here fall short: the two hyperlink targets in Licenses.rst are written with one space, and the two block quotes in Format.rst are indented three. This is not a search and replace. Three spaces is correct under a marker written with one space, and a continuation line has to keep lining up with where its item text begins, so each construct was moved as a whole. The markup shown inside code blocks was left alone. This manual demonstrates reST for a living, and 41 of its example lines deliberately or accidentally show the narrow form; changing what the guide holds up as an example is an editorial decision, not an indentation fix. The rendered output is unchanged. All 95 pages were rendered before and after and compared byte for byte; they differ only in the build timestamp. Assisted-by: Claude Opus 5 Signed-off-by: Lina Wolf --- Documentation/Advanced/Format.rst | 12 ++++++------ Documentation/Advanced/Licenses.rst | 4 ++-- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/Documentation/Advanced/Format.rst b/Documentation/Advanced/Format.rst index d3862e0e..bba6e273 100644 --- a/Documentation/Advanced/Format.rst +++ b/Documentation/Advanced/Format.rst @@ -57,16 +57,16 @@ reST vs. Markdown Victor Zverovich makes the comparison: - According to John Gruber, the inventor of Markdown, “Markdown’s syntax is intended for one - purpose: to be used as a format for writing for the web.” and, in particular, it supports inline HTML. - reStructuredText on the other hand is specifically designed for writing technical documentation. + According to John Gruber, the inventor of Markdown, “Markdown’s syntax is intended for one + purpose: to be used as a format for writing for the web.” and, in particular, it supports inline HTML. + reStructuredText on the other hand is specifically designed for writing technical documentation. readthedocs: - "It should be noted that Commonmark doesn’t support a lot of the concepts that RST lets you represent. - In particular, there is no standardized way in Commonmark to represent inline or block levels constructs. - So things like the toctree directive and :ref: markup don’t have an analog." + "It should be noted that Commonmark doesn’t support a lot of the concepts that RST lets you represent. + In particular, there is no standardized way in Commonmark to represent inline or block levels constructs. + So things like the toctree directive and :ref: markup don’t have an analog." `Read the Docs & Sphinx now support Commonmark `__ (2015) diff --git a/Documentation/Advanced/Licenses.rst b/Documentation/Advanced/Licenses.rst index 0731ca14..8041f928 100644 --- a/Documentation/Advanced/Licenses.rst +++ b/Documentation/Advanced/Licenses.rst @@ -16,5 +16,5 @@ We keep that until something else may be decided somewhere in the future. New manuals should be licensed under `Creative Commons BY 4.0`_. -.. _Open Publication License: https://www.opencontent.org/openpub/ -.. _Creative Commons BY 4.0: https://creativecommons.org/licenses/by/4.0/ +.. _Open Publication License: https://www.opencontent.org/openpub/ +.. _Creative Commons BY 4.0: https://creativecommons.org/licenses/by/4.0/