在Sphinx构建上运行依赖标签的Python脚本

Question

我需要运行一个简单的Python脚本，以在我的Sphinx文档的构建阶段将一组文件从一个目录复制到另一个目录。

复制功能：

位置：source/_plugins/copy_firmware_files.py

import json, os, sys
from pathlib import Path
import shutil


def copy_firmware_files(device):
   # copy firmware files 

我当前正在将此模块导入到我的conf.py中，因为配置文件包含设备名称，这将使它成为执行代码的简单方法。我目前正在执行以下操作：

配置文件（conf.py）

位置：source/conf.py

sys.path.append(os.path.abspath("_plugins"))
from copy_firmware_files import *

# initialize files depending on build
copy_firmware_files(device_name)

以上操作符合预期，即在构建之前将相关文件复制到各自的文件夹中。但是，我不确定这是否是“正确”的方法。是否有更正确的方法来达到相同的结果？

Answer 1

有几种方法，但听起来两种方法最合适。它们是静态文件，Sphinx可以将其视为此类文件。

1. html_extra_path是一个选项。

2. 如果您想提供下载文件的链接，则可以使用html_extra_path。

   download directive