是否可通过Jupyter Book的_config.yml设置Sphinx autodoc模块路径?
实现方案
完全可以通过Jupyter Book的原生配置实现该需求,不需要每次手动修改生成的Sphinx conf.py 文件,推荐两种可行方式:
方式1:直接在Jupyter Book配置中注入路径代码
打开你书籍根目录的_config.yml配置文件,添加sphinx.extra_conf配置项,将路径设置代码作为多行字符串写入即可:
sphinx: extra_conf: | import os import sys sys.path.insert(0, os.path.abspath("my/module/path"))
说明:YAML语法中
|代表保留换行的多行字符串,你写入该字段的所有代码都会在执行jupyter-book config sphinx命令生成conf.py时自动追加到文件末尾,无需手动编辑。
方式2:独立路径配置文件引入
如果需要配置的路径逻辑比较复杂,不想堆砌在YAML文件中,可以单独编写路径配置文件(比如命名为module_path_config.py),将所有路径设置代码写入该文件,再在_config.yml中引入即可:
sphinx: extra_conf: | exec(open("module_path_config.py").read())
注意:配置中写的文件路径要相对于执行
jupyter-book config sphinx命令的工作目录,或直接写绝对路径,避免读取文件报错。
内容的提问来源于stack exchange,提问作者Paolo Amoroso
相关产品推荐
相关产品推荐

