2024年最全【LAMMPS学习】三、构建LAMMPS(8)构建 LAMMPS 文档，2024年最新大数据开发面试基础知识

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

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

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

README           # brief info about the documentation
src              # content files for LAMMPS documentation
html             # HTML version of the LAMMPS manual (see html/Manual.html)
utils            # tools and settings for building the documentation
lammps.1         # man page for the lammps command
msi2lmp.1        # man page for the msi2lmp command
Manual.pdf       # large PDF version of entire manual
LAMMPS.epub      # Manual in ePUB e-book format
LAMMPS.mobi      # Manual in MOBI e-book format
docenv           # virtualenv folder for processing the manual sources
doctrees         # temporary data from processing the manual
doxygen          # doxygen configuration and output
.gitignore       # list of files and folders to be ignored by git
doxygen-warn.log # logfile with warnings from running doxygen
github-development-workflow.md   # notes on the LAMMPS development workflow

如果您从 LAMMPS 网站下载 LAMMPS 作为 tarball，则应包含 html 文件夹和 PDF 文件。

如果您从公共 git 存储库下载 LAMMPS，则不包含 HTML 和 PDF 文件。您可以通过在 doc 文件夹中键入 make html 或 make pdf 自行构建 HTML 或 PDF 文件。这需要各种工具和文件。其中一些必须安装（见下文）。对于其余部分，构建过程将尝试下载并将它们安装到 python 虚拟环境和本地文件夹中。

该手册的当前版本（最新功能版本，即发布分支的状态）可在线获取：https://docs.lammps.org/。与正在进行的开发（即开发分支的状态）相对应的手册版本可在线获取：https://docs.lammps.org/latest/ 与最新稳定的 LAMMPS 版本相对应的手册版本（这是稳定分支的状态）可在线获取：https://docs.lammps.org/stable/

3.8.1.使用 GNU make 构建

LAMMPS 手册以 reStructuredText 格式编写，可以使用 Sphinx 文档生成器工具将其转换为不同的输出格式。它还包含通过 Doxygen 程序从 LAMMPS C++ 源代码中提取的程序员文档。目前支持翻译为 HTML、PDF（通过 LaTeX）、ePUB（对于许多电子书阅读器）和 MOBI（对于 Amazon Kindle 阅读器）。为了使 Python 解释器版本 3.8 或更高版本正常工作，需要 doxygen 工具以及用于下载其他文件和工具的 Internet 访问权限。通常仅需要一次或在使用 make clean-all 将文档文件夹返回到原始状态后才需要进行此下载。

对于文档构建，在文件夹 doc/docenv 中设置了 python 虚拟环境，并通过 pip 工具将各种 python 包安装到该虚拟环境中。为了渲染嵌入式 LaTeX 代码，还需要下载 MathJax JavaScript 引擎。如果您需要将其他选项传递给 pip 命令才能工作（例如，使用 Web 代理或指向其他 SSL 证书），您可以通过 PIP_OPTIONS 环境变量进行设置，或者取消注释并编辑 PIP_OPTIONS 在 makefile 开头设置。

然后通过 doc 文件夹中的 make 命令完成实际编译。以下 make 命令可用：

make html          # generate HTML in html dir using Sphinx
make pdf           # generate PDF  as Manual.pdf using Sphinx and PDFLaTeX
make epub          # generate LAMMPS.epub in ePUB format using Sphinx
make mobi          # generate LAMMPS.mobi in MOBI format using ebook-convert

make fasthtml      # generate approximate HTML in fasthtml dir using Sphinx
                   # some Sphinx extensions do not work correctly with this

make clean         # remove intermediate RST files created by HTML build
make clean-all     # remove entire build folder and any cached data

make anchor_check  # check for duplicate anchor labels
make style_check   # check for complete and consistent style lists
make package_check # check for complete and consistent package lists
make link_check    # check for broken or outdated URLs
make spelling      # spell-check the manual

3.8.2.使用 CMake 构建

还可以在 CMake 构建目录中创建手册的 HTML 版本（并且仅 HTML 版本）。使用此选项的原因是在通过 cmake --build . --target install CMake 构建后安装 LAMMPS 时，将 HTML 手册页的安装包含到“安装”步骤中。文档构建包含在默认构建目标中，但也可以通过 cmake --build . --target doc 独立请求。如果您需要将其他选项传递给 pip 命令才能工作（例如，使用 Web 代理或指向其他 SSL 证书），您可以通过 PIP_OPTIONS 环境变量进行设置。

-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。

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

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

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

/bbs.csdn.net/topics/618545628)**

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！