some more small tweaks of explanation and spelling fixes

This commit is contained in:
Axel Kohlmeyer
2025-03-15 16:38:12 -04:00
parent bca920a021
commit 96f135c294
2 changed files with 7 additions and 3 deletions

View File

@ -221,8 +221,9 @@ HTML as a quick-n-dirty way of checking your manual page.
This translation uses `Pandoc <https://pandoc.org>`_ instead of Sphinx
and thus all special Sphinx features (cross-references, advanced tables,
embedding of Python docstring and doxygen documentation, and so on) will
not render correctly. But this is a **very fast** way to check the content
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 syntaxs and layout of documentation
as HTML while writing the documentation.
To translate **all** manual pages, you can type ``make fasthtml`` at the
@ -235,7 +236,8 @@ 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.
correctly in the actual translations used for download and online
documentation.
Tests for consistency, completeness, and other known issues
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

View File

@ -856,6 +856,7 @@ DNi
Dobnikar
Dobson
docenv
docstrings
Dodds
dodgerblue
dof
@ -3261,6 +3262,7 @@ resquared
REsquared
restartfile
restartinfo
reStructuredText
Restrepo
rethrowing
Revenga