ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

small clarification cherry-picked from PR #4502

Browse Source
This commit is contained in:
Axel Kohlmeyer
2025-03-22 15:47:52 -04:00
parent 6f24e1edd5
commit f4b92a23ae
1 changed files with 3 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
doc/src/Build_manual.rst
View File

@ -223,8 +223,8 @@ This translation uses `Pandoc <https://pandoc.org>`_ instead of Sphinx
and thus all special Sphinx features (cross-references, advanced tables, and thus all special Sphinx features (cross-references, advanced tables,
embedding of Python docstrings or doxygen documentation, and so on) will embedding of Python docstrings or doxygen documentation, and so on) will
not render correctly. Most embedded math should render correctly. This not render correctly. Most embedded math should render correctly. This
is a **very fast** way to check the syntaxes and layout of documentation is a **very fast** way to check the syntax and layout of a documentation
as HTML while writing the documentation. file translated to HTML while writing or updating it.
To translate **all** manual pages, you can type ``make fasthtml`` at the To translate **all** manual pages, you can type ``make fasthtml`` at the
command line. The translated HTML files are then in the ``fasthtml`` 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 After writing the documentation is completed, you will still need
to verify with ``make html`` and ``make pdf`` that it translates to verify with ``make html`` and ``make pdf`` that it translates
correctly in the actual translations used for downloaded and online correctly in both formats.
documentation.
Tests for consistency, completeness, and other known issues Tests for consistency, completeness, and other known issues
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^