From f4b92a23ae79e793c08db5dc09c103fce6ab1188 Mon Sep 17 00:00:00 2001 From: Axel Kohlmeyer Date: Sat, 22 Mar 2025 15:47:52 -0400 Subject: [PATCH] small clarification cherry-picked from PR #4502 --- doc/src/Build_manual.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/src/Build_manual.rst b/doc/src/Build_manual.rst index dea98e9b61..2fc29f584b 100644 --- a/doc/src/Build_manual.rst +++ b/doc/src/Build_manual.rst @@ -223,8 +223,8 @@ This translation uses `Pandoc `_ instead of Sphinx and thus all special Sphinx features (cross-references, advanced tables, embedding of Python docstrings or doxygen documentation, and so on) will not render correctly. Most embedded math should render correctly. This -is a **very fast** way to check the syntaxes and layout of documentation -as HTML while writing the documentation. +is a **very fast** way to check the syntax and layout of a documentation +file translated to HTML while writing or updating it. To translate **all** manual pages, you can type ``make fasthtml`` at the command line. The translated HTML files are then in the ``fasthtml`` @@ -236,8 +236,7 @@ directly translate only individual pages: e.g. to translate only the After writing the documentation is completed, you will still need to verify with ``make html`` and ``make pdf`` that it translates -correctly in the actual translations used for downloaded and online -documentation. +correctly in both formats. Tests for consistency, completeness, and other known issues ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^