是否可以从 Jupyter Book 设置 Sphinx autodoc 模块路径？

Question

是否可以从 Jupyter Book

 设置 Sphinx 

autodoc Python 模块路径 ，例如通过

_config.yml

？

我正在使用 Jupyter Book 来记录 Python 系统并发布到“阅读文档”。我可以通过将这样的代码添加到

conf.py

:

来设置 Sphinx 的模块路径

import os
import sys
sys.path.insert(0, os.path.abspath("my/module/path"))

但是，我更愿意完全从 Jupyter Book 一侧控制路径。否则我必须在使用

conf.py

生成文件后手动编辑

jupyter-book config sphinx path/to/book

。

Answer 1

尝试使用

currentmodule

指令。

例如，如果您在“my_package/my_file.py”中定义了一个名为

MyClass

的类，您可以在 RST 文件中尝试类似的操作：

My Heading
===========

.. currentmodule:: my_package.my_file

.. autoclass:: MyClass
    :members:
    :undoc-members: