文档¶
FBGEMM 和 FBGEMM_GPU 都在其源文件中提供了大量的注释，这些注释是这两个库目前最权威和最新的文档。
通用文档指南¶
当添加新的公共 API 方法时，应附带充分的文档。以下是记录 FBGEMM 和 FBGEMM_GPU 代码的一些指南
代码本身不是文档！ 请站在必须理解您的代码的新开发人员的角度，让他们更轻松地理解您的代码。
应为所有公共 API 方法添加文档。
不要将文档留作单独的任务。相反，请与代码一起编写文档字符串。
至少，添加
方法的描述。
可以传递给方法的参数和自变量的描述。
方法返回值的描述。
用法示例、指向其他方法的链接以及方法调用限制。
特定文档指南¶
构建文档¶
注意： 最新的文档构建说明嵌入在 FBGEMM 仓库 setup_env.bash 中捆绑的一组脚本中。
构建 FBGEMM 和 FBGEMM_GPU 文档的一般步骤如下
设置隔离的构建环境。
构建 FBGEMM_GPU（CPU 变体）。
设置文档工具链。
运行文档构建脚本。
设置构建环境¶
按照 设置隔离的构建环境 中的说明设置 Conda 环境。
构建 FBGEMM_GPU¶
需要构建 FBGEMM_GPU 才能正确构建文档。按照 安装构建工具 中的说明，然后按照 仅 CPU 构建 中的说明构建 FBGEMM_GPU（CPU 变体）。
设置文档工具链¶
# !! Run inside the Conda environment !!
# From the /fbgemm_gpu/ directory
cd docs
# Install Sphinx and other Python packages
pip install -r requirements.txt
# Install Doxygen and and other tools
conda install -c conda-forge --override-channels -y \
doxygen \
graphviz \
make
构建文档¶
# Generate the C++ documentation, the Python documentation, and assemble
# together
make clean doxygen html
构建完成后，查看生成的文档
sphinx-serve -b build
文档 Lint¶
用于构建的相同命令也可用于 Lint，只需在前面加上 SPHINX_LINT 标志
SPHINX_LINT=1 make clean doxygen html
由于技术原因，启用 Lint 功能运行 Sphinx 构建会导致文档组装不正确，这就是 Lint 与构建分开调用的原因。
有时，未解决的引用可能会在 Lint 时出现，并具有以下错误签名
/opt/build/repo/fbgemm_gpu/docs/docstring of torch._ops.fbgemm.PyCapsule.jagged_2d_to_dense:1:py:class reference target not found: Tensor
如果这些错误被证明是误报，可以通过将其添加到 nitpick.ignore 文件（与 Sphinx conf.py 位于同一目录中）来消除它们
# Add in `{domain} {reference}` format, with space in between.
py:class Tensor
部署预览¶
当发出拉取请求时，Netlify 将自动构建和部署 FBGEMM 和 FBGEMM_GPU 文档的预览。构建完成后，可以在以下位置找到部署预览
https://deploy-preview-{PR NUMBER}--pytorch-fbgemm-docs.netlify.app/
