最新【LAMMPS学习】三、构建LAMMPS(8)构建 LAMMPS 文档，大数据开发开发还不会这些

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上大数据知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化资料的朋友，可以戳这里获取

-D BUILD_DOC=value       # yes or no (default)

3.8.3. HTML 的先决条件

要运行 HTML 文档构建工具链，必须在本地安装 python 3、git、doxygen 和 virtualenv。以下是常见设置的说明：

Ubuntu

sudo apt-get install git doxygen

**RHEL or CentOS (Version 7.x)**

sudo yum install git doxygen

**Fedora or RHEL/CentOS (8.x or later)**

sudo dnf install git doxygen

MacOS

如果您的 macOS 系统上没有 Python 3，您可以从 https://www.python.org 下载最新的 Python 3 macOS 软件包并安装。这将安装 Python 3 和 pip3。

3.8.4. PDF 的先决条件

除了构建 HTML 格式手册所需的工具之外，还需要支持 PDFLaTeX 的工作 LaTeX 安装以及精选的 LaTeX 样式/包。要运行 PDFLaTeX 翻译，还需要安装 latexmk 脚本。

3.8.5. ePUB 和 MOBI 的先决条件

除了构建 HTML 格式手册所需的工具之外，还需要使用一些附加 LaTeX 包以及 dvipng 工具来安装有效的 LaTeX，以将嵌入式数学表达式透明地转换为嵌入式图像。

要将生成的 ePUB 文件转换为 MOBI 格式文件（对于无法读取 ePUB 的电子书阅读器，如 Kindle），您还需要安装“calibre”软件中的 ebook-convert 工具。 https://calibre-ebook.com/ 输入 make mobi 将首先创建 ePUB 文件，然后对其进行转换。特别是在 Kindle 阅读器上，您还支持 PDF 文件，因此您可以下载并查看 PDF 版本作为替代方案。

3.8.6. 开发者须知

当向 LAMMPS 代码添加新样式或选项时，需要相应的文档，并且需要更新 src 文件夹中的现有文件或添加新文件。这些文件以 reStructuredText 标记编写，以便使用 Sphinx 工具进行翻译。

在提供任何文档之前，请检查 HTML 和 PDF 格式文档是否可以正确翻译。在测试 html 翻译期间，您可以使用 make fasthtml 命令进行近似翻译（即并非所有 Sphinx 功能和扩展都可以工作），但运行速度非常快，因为它只会翻译自此以来已更改的文件最后一个 make fasthtml 命令。

另请检查控制台的输出是否有任何警告或问题。将自动运行多个测试：

• 测试所有锚标签及其引用的正确性
• 测试所有 LAMMPS 包（= 源位于 lammps/src 中的文件夹）是否已记录并列出。典型的警告会显示包含可疑新包代码的文件夹名称以及需要列出它们的文档文件：

Found 88 packages
Package NEWPACKAGE missing in Packages_list.rst
Package NEWPACKAGE missing in Packages_details.rst

• 仅使用标准的可打印 ASCII 文本字符的测试。这将运行命令 env LC_ALL=C grep -n '[^ -~]' src/*.rst ，从而打印所有有问题的行，并在屏幕上添加文件名和行号。特殊字符，例如希腊字母、上标或下标、数学表达式或埃符号( Å, :math:x^2 \mathrm{E}_{LJ}`` 、 :math:\frac{1}2}\mathrm{N} x\to\infty`` 或 `:math:`\AA`` ）。
• 嵌入式 LaTeX 通过 MathJax 在 HTML 输出中呈现，并通过将嵌入文本传递给 LaTeX 在 PDF 输出中呈现。不过，必须要小心，因为在任一模式下使用宏和功能都存在限制，因此建议始终检查任何新的或更改的文档是否能够正确地使用任一输出进行翻译和渲染。
• 测试所有样式是否都已记录并在各自的概述页面中列出。带有警告的典型输出如下所示：

Parsed style names w/o suffixes from C++ tree in ../src:
   Angle styles:      21    Atom styles:       24
   Body styles:        3    Bond styles:       17
   Command styles:    41    Compute styles:   143
   Dihedral styles:   16    Dump styles:       26
   Fix styles:       223    Improper styles:   13
   Integrate styles:   4    Kspace styles:     15
   Minimize styles:    9    Pair styles:      234
   Reader styles:      4    Region styles:      8
Compute style entry newcomp is missing or incomplete in Commands_compute.rst
Compute style entry newcomp is missing or incomplete in compute.rst
Fix style entry newfix is missing or incomplete in Commands_fix.rst
Fix style entry newfix is missing or incomplete in fix.rst
Pair style entry new is missing or incomplete in Commands_pair.rst
Pair style entry new is missing or incomplete in pair_style.rst
Found 6 issue(s) with style lists

此外，还可以选择使用 make spelling 对整个手册运行拼写检查。这需要一个名为 enchant 的库。为了避免打印出误报（例如关键字、名称、缩写），可以将它们添加到文件 lammps/doc/utils/sphinx-config/false_positives.txt 中。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上大数据知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化资料的朋友，可以戳这里获取

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

需要这份系统化资料的朋友，可以戳这里获取